diff --git a/.github/workflows/generate-js-reference.yml b/.github/workflows/generate-js-reference.yml index 98588aa670..5c28fe2ed1 100644 --- a/.github/workflows/generate-js-reference.yml +++ b/.github/workflows/generate-js-reference.yml @@ -41,14 +41,14 @@ jobs: run: yarn build - name: Generate Services Reference - run: yarn generate:services + run: yarn generate:js-client - name: Create Pull Request uses: peter-evans/create-pull-request@v4 with: commit-message: 'chore(docs): Generated JS Client Reference (automated)' base: 'master' - title: 'chore(docs): Updated API Reference' + title: 'chore(docs): Generated JS Client Reference' labels: 'type: chore' add-paths: docs/content/references/js-client/** branch: 'chore/generate-js-client' diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json index 92a6943bac..44dd9c87f5 100644 --- a/docs/api/admin-spec3.json +++ b/docs/api/admin-spec3.json @@ -15,6 +15,89 @@ info: + + + ## Expanding Fields + + + In many endpoints you'll find an `expand` query parameter that can be passed + to the endpoint. You can use the `expand` query parameter to unpack an + entity's relations and return them in the response. + + + For example, when you list customers you can also retrieve their groups by + passing to the `expand` query parameter the value `groups`. + + + You can expand more than one relation by separating the relations in the + `expand` query parameter with a comma. For example, to retrieve both the + orders and the groups of a customer, pass to the `expand` query parameter + the value `groups,orders`. + + + Please note that the parameters you pass to `expand` replace any relations + that are expanded by default. + + + ## Selecting Fields + + + In many endpoints you'll find a `fields` query parameter that can be passed + to the endpoint. You can use the `fields` query parameter to specify which + fields in the entity should be returned in the response. + + + You can pass more than one field by seperating the field names in the + `fields` query parameter with a comma. + + + Only the fields you pass to `field` will be retrieved and returned in the + response. Any fields that are returned by default will not be returned in + this case. This does not affect relations. + + + For example, to only select the `title` and `description` fields of a + product, pass to the `fields` query parameter the value `title,description`. + + + ## Pagination + + + ### Query Parameters + + + In listing endpoints, such as list customers or list products, you can + control the pagination using the query parameters `limit` and `offset`. + + + `limit` is used to specify the maximum number of items that can be return in + the response. `offset` is used to specify how many items to skip before + returning the resulting entities. + + + You can use the `offset` query parameter to change between pages. For + example, if the limit is 50, at page 1 the offset should be 0; at page 2 the + offset should be 50, and so on. + + + ### Response Fields + + + In listing fields, aside from the entities retrieved, there are three + pagination-related fields returned: `count`, `limit`, and `offset`. + + + Similarly to the query parameters, `limit` is the maximum number of items + that can be returned in the response, and `field` is the number of items + that were skipped before the entities in the result. + + + `count` is the total number of available items of this entity. It can be + used to determine how many pages are there. + + + For example, if the `count` is 100 and the `limit` is 50, you can divide the + `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. license: name: MIT url: 'https://github.com/medusajs/medusa/blob/master/LICENSE' @@ -2075,7 +2158,7 @@ paths: medusa.admin.customerGroups.list() .then(({ customer_groups, limit, offset, count }) => { - console.log(customer_groups.id); + console.log(customer_groups.length); }); - lang: Shell label: cURL @@ -4338,10 +4421,10 @@ paths: format: email billing_address: description: The Address to be used for billing purposes. - $ref: '#/components/schemas/address' + $ref: '#/components/schemas/address_fields' shipping_address: description: The Address to be used for shipping. - $ref: '#/components/schemas/address' + $ref: '#/components/schemas/address_fields' items: description: The Line Items that have been received. type: array @@ -5068,10 +5151,10 @@ paths: format: email billing_address: description: The Address to be used for billing purposes. - $ref: '#/components/schemas/address' + $ref: '#/components/schemas/address_fields' shipping_address: description: The Address to be used for shipping. - $ref: '#/components/schemas/address' + $ref: '#/components/schemas/address_fields' discounts: description: An array of Discount codes to add to the Draft Order. type: array @@ -6490,6 +6573,689 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/order-edits/{id}/items': + post: + operationId: PostOrderEditsEditLineItems + summary: Add an line item to an order (edit) + description: Create an OrderEdit LineItem. + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit. + schema: + type: string + x-authenticated: true + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.addLineItem(order_edit_id, { variant_id, + quantity }) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/{id}/items' \ + + --header 'Authorization: Bearer {api_token}' + + -d '{ "variant_id": "some_variant_id", "quantity": 3 }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/cancel': + post: + operationId: PostOrderEditsOrderEditCancel + summary: Cancel an OrderEdit + description: Cancels an OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.cancel(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/:id/cancel' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/confirm': + post: + operationId: PostOrderEditsOrderEditConfirm + summary: Confirms an OrderEdit + description: Confirms an OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the order edit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.confirm(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/:id/confirm' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + /order-edits: + post: + operationId: PostOrderEdits + summary: Create an OrderEdit + description: Creates an OrderEdit. + x-authenticated: true + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.create({ order_id, internal_note }) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits' \ + + --header 'Authorization: Bearer {api_token}' + + -d '{ "order_id": "my_order_id", "internal_note": "my_optional_note" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/items/{item_id}': + delete: + operationId: DeleteOrderEditsOrderEditLineItemsLineItem + summary: Delete line items from an order edit and create change item + description: Delete line items from an order edit and create change item + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete from. + schema: + type: string + - in: path + name: item_id + required: true + description: The ID of the order edit item to delete from order. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.removeLineItem(order_edit_id, line_item_id) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostOrderEditsEditLineItemsLineItem + summary: Create or update the order edit change holding the line item changes + description: Create or update the order edit change holding the line item changes + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to update. + schema: + type: string + - in: path + name: item_id + required: true + description: The ID of the order edit item to update. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.updateLineItem(order_edit_id, line_item_id) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \ + + --header 'Authorization: Bearer {api_token}' + + -d '{ "quantity": 5 }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/changes/{change_id}': + delete: + operationId: DeleteOrderEditsOrderEditItemChange + summary: Delete an Order Edit Item Change + description: Deletes an Order Edit Item Change + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete. + schema: + type: string + - in: path + name: change_id + required: true + description: The ID of the Order Edit Item Change to delete. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.deleteItemChange(item_change_id, + order_edit_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/order-edits/{id}/changes/{change_id}' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + id: + type: string + description: The ID of the deleted Order Edit Item Change. + object: + type: string + description: The type of the object that was deleted. + format: item_change + deleted: + type: boolean + description: Whether or not the Order Edit Item Change was deleted. + default: true + '400': + $ref: '#/components/responses/400_error' + '/order-edits/{id}': + delete: + operationId: DeleteOrderEditsOrderEdit + summary: Delete an Order Edit + description: Deletes an Order Edit + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.delete(edit_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/order-edits/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + id: + type: string + description: The ID of the deleted Order Edit. + object: + type: string + description: The type of the object that was deleted. + format: order_edit + deleted: + type: boolean + description: Whether or not the Order Edit was deleted. + default: true + '400': + $ref: '#/components/responses/400_error' + get: + operationId: GetOrderEditsOrderEdit + summary: Retrieve an OrderEdit + description: Retrieves a OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.retrieve(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/order-edits/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostOrderEditsOrderEdit + summary: Updates an OrderEdit + description: Updates a OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + const params = {internal_note: "internal reason XY"} + + medusa.admin.orderEdit.update(orderEditId, params) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/{id}' \ + + --header 'Authorization: Bearer {api_token}' + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "internal_note": "internal reason XY" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/request': + post: + operationId: PostOrderEditsOrderEditRequest + summary: Request order edit confirmation + description: Request customer confirmation of an Order Edit + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to request confirmation from. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.requestConfirmation(edit_id) + .then({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/{id}/request' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' '/orders/{id}/shipping-methods': post: operationId: PostOrdersOrderShippingMethods @@ -8214,11 +8980,11 @@ paths: billing_address: description: Billing address anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/address_fields' shipping_address: description: Shipping address anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/address_fields' items: description: The Line Items for the order type: array @@ -18496,6 +19262,60 @@ components: Where `{sid}` is the value of `connect.sid` that you copied. schemas: + address_fields: + title: Address Fields + description: Address fields used when creating/updating an address. + x-resourceId: address + properties: + company: + type: string + description: Company name + example: Acme + first_name: + type: string + description: First name + example: Arno + last_name: + type: string + description: Last name + example: Willms + address_1: + type: string + description: Address line 1 + example: 14433 Kemmer Court + address_2: + type: string + description: Address line 2 + example: Suite 369 + city: + type: string + description: City + example: South Geoffreyview + country_code: + type: string + description: The 2 character ISO code of the country in lower case + externalDocs: + url: >- + https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + example: st + province: + type: string + description: Province + example: Kentucky + postal_code: + type: string + description: Postal Code + example: 72093 + phone: + type: string + description: Phone Number + example: 16128234334802 + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white address: title: Address description: An address. @@ -20630,6 +21450,17 @@ components: includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean + original_item_id: + description: '[EXPERIMENTAL] The id of the original line item' + type: string + order_edit_id: + description: >- + [EXPERIMENTAL] The ID of the order edit to which a cloned item + belongs + type: string + order_edit: + description: '[EXPERIMENTAL] The order edit joined' + type: object created_at: type: string description: The date with timezone at which the resource was created. @@ -21035,12 +21866,24 @@ components: type: string subtotal: type: integer - description: The subtotal for line items computed from changes. + description: The total of subtotal example: 8000 discount_total: type: integer description: The total of discount example: 800 + shipping_total: + type: integer + description: The total of the shipping amount + example: 800 + gift_card_total: + type: integer + description: The total of the gift card amount + example: 800 + gift_card_tax_total: + type: integer + description: The total of the gift card tax amount + example: 800 tax_total: type: integer description: The total of tax @@ -22099,6 +22942,46 @@ components: description: An optional key-value map with additional details example: car: white + product_variant_prices_fields: + title: Product Variant Prices Fields + description: Product Variants Prices Fields that are only available in some requests. + x-resourceId: product_variant_prices_fields + properties: + original_price: + type: number + description: >- + The original price of the variant without any discounted prices + applied. + calculated_price: + type: number + description: The calculated price of the variant. Can be a discounted price. + original_price_incl_tax: + type: number + description: The original price of the variant including taxes. + calculated_price_incl_tax: + type: number + description: The calculated price of the variant including taxes. + original_tax: + type: number + description: The taxes applied on the original price. + calculated_tax: + type: number + description: The taxes applied on the calculated price. + tax_rates: + type: array + description: An array of applied tax rates + items: + type: object + properties: + rate: + type: number + description: The tax rate value + name: + type: string + description: The name of the tax rate + code: + type: string + description: The code of the tax rate product: title: Product description: >- diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml index 92a6943bac..44dd9c87f5 100644 --- a/docs/api/admin-spec3.yaml +++ b/docs/api/admin-spec3.yaml @@ -15,6 +15,89 @@ info: + + + ## Expanding Fields + + + In many endpoints you'll find an `expand` query parameter that can be passed + to the endpoint. You can use the `expand` query parameter to unpack an + entity's relations and return them in the response. + + + For example, when you list customers you can also retrieve their groups by + passing to the `expand` query parameter the value `groups`. + + + You can expand more than one relation by separating the relations in the + `expand` query parameter with a comma. For example, to retrieve both the + orders and the groups of a customer, pass to the `expand` query parameter + the value `groups,orders`. + + + Please note that the parameters you pass to `expand` replace any relations + that are expanded by default. + + + ## Selecting Fields + + + In many endpoints you'll find a `fields` query parameter that can be passed + to the endpoint. You can use the `fields` query parameter to specify which + fields in the entity should be returned in the response. + + + You can pass more than one field by seperating the field names in the + `fields` query parameter with a comma. + + + Only the fields you pass to `field` will be retrieved and returned in the + response. Any fields that are returned by default will not be returned in + this case. This does not affect relations. + + + For example, to only select the `title` and `description` fields of a + product, pass to the `fields` query parameter the value `title,description`. + + + ## Pagination + + + ### Query Parameters + + + In listing endpoints, such as list customers or list products, you can + control the pagination using the query parameters `limit` and `offset`. + + + `limit` is used to specify the maximum number of items that can be return in + the response. `offset` is used to specify how many items to skip before + returning the resulting entities. + + + You can use the `offset` query parameter to change between pages. For + example, if the limit is 50, at page 1 the offset should be 0; at page 2 the + offset should be 50, and so on. + + + ### Response Fields + + + In listing fields, aside from the entities retrieved, there are three + pagination-related fields returned: `count`, `limit`, and `offset`. + + + Similarly to the query parameters, `limit` is the maximum number of items + that can be returned in the response, and `field` is the number of items + that were skipped before the entities in the result. + + + `count` is the total number of available items of this entity. It can be + used to determine how many pages are there. + + + For example, if the `count` is 100 and the `limit` is 50, you can divide the + `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. license: name: MIT url: 'https://github.com/medusajs/medusa/blob/master/LICENSE' @@ -2075,7 +2158,7 @@ paths: medusa.admin.customerGroups.list() .then(({ customer_groups, limit, offset, count }) => { - console.log(customer_groups.id); + console.log(customer_groups.length); }); - lang: Shell label: cURL @@ -4338,10 +4421,10 @@ paths: format: email billing_address: description: The Address to be used for billing purposes. - $ref: '#/components/schemas/address' + $ref: '#/components/schemas/address_fields' shipping_address: description: The Address to be used for shipping. - $ref: '#/components/schemas/address' + $ref: '#/components/schemas/address_fields' items: description: The Line Items that have been received. type: array @@ -5068,10 +5151,10 @@ paths: format: email billing_address: description: The Address to be used for billing purposes. - $ref: '#/components/schemas/address' + $ref: '#/components/schemas/address_fields' shipping_address: description: The Address to be used for shipping. - $ref: '#/components/schemas/address' + $ref: '#/components/schemas/address_fields' discounts: description: An array of Discount codes to add to the Draft Order. type: array @@ -6490,6 +6573,689 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/order-edits/{id}/items': + post: + operationId: PostOrderEditsEditLineItems + summary: Add an line item to an order (edit) + description: Create an OrderEdit LineItem. + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit. + schema: + type: string + x-authenticated: true + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.addLineItem(order_edit_id, { variant_id, + quantity }) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/{id}/items' \ + + --header 'Authorization: Bearer {api_token}' + + -d '{ "variant_id": "some_variant_id", "quantity": 3 }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/cancel': + post: + operationId: PostOrderEditsOrderEditCancel + summary: Cancel an OrderEdit + description: Cancels an OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.cancel(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/:id/cancel' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/confirm': + post: + operationId: PostOrderEditsOrderEditConfirm + summary: Confirms an OrderEdit + description: Confirms an OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the order edit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.confirm(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/:id/confirm' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + /order-edits: + post: + operationId: PostOrderEdits + summary: Create an OrderEdit + description: Creates an OrderEdit. + x-authenticated: true + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.create({ order_id, internal_note }) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits' \ + + --header 'Authorization: Bearer {api_token}' + + -d '{ "order_id": "my_order_id", "internal_note": "my_optional_note" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/items/{item_id}': + delete: + operationId: DeleteOrderEditsOrderEditLineItemsLineItem + summary: Delete line items from an order edit and create change item + description: Delete line items from an order edit and create change item + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete from. + schema: + type: string + - in: path + name: item_id + required: true + description: The ID of the order edit item to delete from order. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.removeLineItem(order_edit_id, line_item_id) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostOrderEditsEditLineItemsLineItem + summary: Create or update the order edit change holding the line item changes + description: Create or update the order edit change holding the line item changes + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to update. + schema: + type: string + - in: path + name: item_id + required: true + description: The ID of the order edit item to update. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.updateLineItem(order_edit_id, line_item_id) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \ + + --header 'Authorization: Bearer {api_token}' + + -d '{ "quantity": 5 }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/changes/{change_id}': + delete: + operationId: DeleteOrderEditsOrderEditItemChange + summary: Delete an Order Edit Item Change + description: Deletes an Order Edit Item Change + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete. + schema: + type: string + - in: path + name: change_id + required: true + description: The ID of the Order Edit Item Change to delete. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.deleteItemChange(item_change_id, + order_edit_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/order-edits/{id}/changes/{change_id}' + \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + id: + type: string + description: The ID of the deleted Order Edit Item Change. + object: + type: string + description: The type of the object that was deleted. + format: item_change + deleted: + type: boolean + description: Whether or not the Order Edit Item Change was deleted. + default: true + '400': + $ref: '#/components/responses/400_error' + '/order-edits/{id}': + delete: + operationId: DeleteOrderEditsOrderEdit + summary: Delete an Order Edit + description: Deletes an Order Edit + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.delete(edit_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request DELETE + 'https://medusa-url.com/admin/order-edits/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + id: + type: string + description: The ID of the deleted Order Edit. + object: + type: string + description: The type of the object that was deleted. + format: order_edit + deleted: + type: boolean + description: Whether or not the Order Edit was deleted. + default: true + '400': + $ref: '#/components/responses/400_error' + get: + operationId: GetOrderEditsOrderEdit + summary: Retrieve an OrderEdit + description: Retrieves a OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdit.retrieve(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/admin/order-edits/{id}' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostOrderEditsOrderEdit + summary: Updates an OrderEdit + description: Updates a OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + const params = {internal_note: "internal reason XY"} + + medusa.admin.orderEdit.update(orderEditId, params) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/{id}' \ + + --header 'Authorization: Bearer {api_token}' + + --header 'Content-Type: application/json' \ + + --data-raw '{ + "internal_note": "internal reason XY" + }' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/request': + post: + operationId: PostOrderEditsOrderEditRequest + summary: Request order edit confirmation + description: Request customer confirmation of an Order Edit + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to request confirmation from. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + // must be previously logged in or use api token + + medusa.admin.orderEdits.requestConfirmation(edit_id) + .then({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/admin/order-edits/{id}/request' \ + + --header 'Authorization: Bearer {api_token}' + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' '/orders/{id}/shipping-methods': post: operationId: PostOrdersOrderShippingMethods @@ -8214,11 +8980,11 @@ paths: billing_address: description: Billing address anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/address_fields' shipping_address: description: Shipping address anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/address_fields' items: description: The Line Items for the order type: array @@ -18496,6 +19262,60 @@ components: Where `{sid}` is the value of `connect.sid` that you copied. schemas: + address_fields: + title: Address Fields + description: Address fields used when creating/updating an address. + x-resourceId: address + properties: + company: + type: string + description: Company name + example: Acme + first_name: + type: string + description: First name + example: Arno + last_name: + type: string + description: Last name + example: Willms + address_1: + type: string + description: Address line 1 + example: 14433 Kemmer Court + address_2: + type: string + description: Address line 2 + example: Suite 369 + city: + type: string + description: City + example: South Geoffreyview + country_code: + type: string + description: The 2 character ISO code of the country in lower case + externalDocs: + url: >- + https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + example: st + province: + type: string + description: Province + example: Kentucky + postal_code: + type: string + description: Postal Code + example: 72093 + phone: + type: string + description: Phone Number + example: 16128234334802 + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white address: title: Address description: An address. @@ -20630,6 +21450,17 @@ components: includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean + original_item_id: + description: '[EXPERIMENTAL] The id of the original line item' + type: string + order_edit_id: + description: >- + [EXPERIMENTAL] The ID of the order edit to which a cloned item + belongs + type: string + order_edit: + description: '[EXPERIMENTAL] The order edit joined' + type: object created_at: type: string description: The date with timezone at which the resource was created. @@ -21035,12 +21866,24 @@ components: type: string subtotal: type: integer - description: The subtotal for line items computed from changes. + description: The total of subtotal example: 8000 discount_total: type: integer description: The total of discount example: 800 + shipping_total: + type: integer + description: The total of the shipping amount + example: 800 + gift_card_total: + type: integer + description: The total of the gift card amount + example: 800 + gift_card_tax_total: + type: integer + description: The total of the gift card tax amount + example: 800 tax_total: type: integer description: The total of tax @@ -22099,6 +22942,46 @@ components: description: An optional key-value map with additional details example: car: white + product_variant_prices_fields: + title: Product Variant Prices Fields + description: Product Variants Prices Fields that are only available in some requests. + x-resourceId: product_variant_prices_fields + properties: + original_price: + type: number + description: >- + The original price of the variant without any discounted prices + applied. + calculated_price: + type: number + description: The calculated price of the variant. Can be a discounted price. + original_price_incl_tax: + type: number + description: The original price of the variant including taxes. + calculated_price_incl_tax: + type: number + description: The calculated price of the variant including taxes. + original_tax: + type: number + description: The taxes applied on the original price. + calculated_tax: + type: number + description: The taxes applied on the calculated price. + tax_rates: + type: array + description: An array of applied tax rates + items: + type: object + properties: + rate: + type: number + description: The tax rate value + name: + type: string + description: The name of the tax rate + code: + type: string + description: The code of the tax rate product: title: Product description: >- diff --git a/docs/api/admin/code_samples/JavaScript/customer-groups/getundefined b/docs/api/admin/code_samples/JavaScript/customer-groups/getundefined index d6cf478ef8..1317339480 100644 --- a/docs/api/admin/code_samples/JavaScript/customer-groups/getundefined +++ b/docs/api/admin/code_samples/JavaScript/customer-groups/getundefined @@ -3,5 +3,5 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) // must be previously logged in or use api token medusa.admin.customerGroups.list() .then(({ customer_groups, limit, offset, count }) => { - console.log(customer_groups.id); + console.log(customer_groups.length); }); diff --git a/docs/api/admin/code_samples/JavaScript/order-edits/postundefined b/docs/api/admin/code_samples/JavaScript/order-edits/postundefined new file mode 100644 index 0000000000..71e4b18f00 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits/postundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdit.create({ order_id, internal_note }) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}/deleteundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}/deleteundefined new file mode 100644 index 0000000000..46359c7fae --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}/deleteundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdits.delete(edit_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}/getundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}/getundefined new file mode 100644 index 0000000000..4ce9358905 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}/getundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdit.retrieve(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}/postundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}/postundefined new file mode 100644 index 0000000000..2440c42378 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}/postundefined @@ -0,0 +1,8 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +const params = {internal_note: "internal reason XY"} +medusa.admin.orderEdit.update(orderEditId, params) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}_cancel/postundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_cancel/postundefined new file mode 100644 index 0000000000..7c6b834206 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_cancel/postundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdit.cancel(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}_changes_{change_id}/deleteundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_changes_{change_id}/deleteundefined new file mode 100644 index 0000000000..c1ef05c2f9 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_changes_{change_id}/deleteundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdits.deleteItemChange(item_change_id, order_edit_id) + .then(({ id, object, deleted }) => { + console.log(id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}_confirm/postundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_confirm/postundefined new file mode 100644 index 0000000000..ab9fc4f042 --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_confirm/postundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdit.confirm(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items/postundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items/postundefined new file mode 100644 index 0000000000..d6569f3b5f --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items/postundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdit.addLineItem(order_edit_id, { variant_id, quantity }) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items_{item_id}/deleteundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items_{item_id}/deleteundefined new file mode 100644 index 0000000000..2c8990247c --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items_{item_id}/deleteundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdits.removeLineItem(order_edit_id, line_item_id) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items_{item_id}/postundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items_{item_id}/postundefined new file mode 100644 index 0000000000..fc95e5299a --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_items_{item_id}/postundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdits.updateLineItem(order_edit_id, line_item_id) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/JavaScript/order-edits_{id}_request/postundefined b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_request/postundefined new file mode 100644 index 0000000000..37e5c1796a --- /dev/null +++ b/docs/api/admin/code_samples/JavaScript/order-edits_{id}_request/postundefined @@ -0,0 +1,7 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +// must be previously logged in or use api token +medusa.admin.orderEdits.requestConfirmation(edit_id) + .then({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/admin/code_samples/Shell/order-edits/postundefined b/docs/api/admin/code_samples/Shell/order-edits/postundefined new file mode 100644 index 0000000000..29b1870d9c --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits/postundefined @@ -0,0 +1,3 @@ +curl --location --request POST 'https://medusa-url.com/admin/order-edits' \ +--header 'Authorization: Bearer {api_token}' +-d '{ "order_id": "my_order_id", "internal_note": "my_optional_note" }' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}/deleteundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}/deleteundefined new file mode 100644 index 0000000000..3cfa445f1e --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}/deleteundefined @@ -0,0 +1,2 @@ +curl --location --request DELETE 'https://medusa-url.com/admin/order-edits/{id}' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}/getundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}/getundefined new file mode 100644 index 0000000000..40f89d51a1 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}/getundefined @@ -0,0 +1,2 @@ +curl --location --request GET 'https://medusa-url.com/admin/order-edits/{id}' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}/postundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}/postundefined new file mode 100644 index 0000000000..3fba5b2aa2 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}/postundefined @@ -0,0 +1,6 @@ +curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}' \ +--header 'Authorization: Bearer {api_token}' +--header 'Content-Type: application/json' \ +--data-raw '{ + "internal_note": "internal reason XY" +}' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}_cancel/postundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}_cancel/postundefined new file mode 100644 index 0000000000..fdda792726 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}_cancel/postundefined @@ -0,0 +1,2 @@ +curl --location --request POST 'https://medusa-url.com/admin/order-edits/:id/cancel' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}_changes_{change_id}/deleteundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}_changes_{change_id}/deleteundefined new file mode 100644 index 0000000000..ea0d3790f8 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}_changes_{change_id}/deleteundefined @@ -0,0 +1,2 @@ +curl --location --request DELETE 'https://medusa-url.com/admin/order-edits/{id}/changes/{change_id}' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}_confirm/postundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}_confirm/postundefined new file mode 100644 index 0000000000..82c18df5dd --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}_confirm/postundefined @@ -0,0 +1,2 @@ +curl --location --request POST 'https://medusa-url.com/admin/order-edits/:id/confirm' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}_items/postundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}_items/postundefined new file mode 100644 index 0000000000..115265370d --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}_items/postundefined @@ -0,0 +1,3 @@ +curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}/items' \ +--header 'Authorization: Bearer {api_token}' +-d '{ "variant_id": "some_variant_id", "quantity": 3 }' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}_items_{item_id}/deleteundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}_items_{item_id}/deleteundefined new file mode 100644 index 0000000000..aaf8210567 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}_items_{item_id}/deleteundefined @@ -0,0 +1,2 @@ +curl --location --request DELETE 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}_items_{item_id}/postundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}_items_{item_id}/postundefined new file mode 100644 index 0000000000..0c72b1352f --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}_items_{item_id}/postundefined @@ -0,0 +1,3 @@ +curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}/items/{item_id}' \ +--header 'Authorization: Bearer {api_token}' +-d '{ "quantity": 5 }' diff --git a/docs/api/admin/code_samples/Shell/order-edits_{id}_request/postundefined b/docs/api/admin/code_samples/Shell/order-edits_{id}_request/postundefined new file mode 100644 index 0000000000..9c19766746 --- /dev/null +++ b/docs/api/admin/code_samples/Shell/order-edits_{id}_request/postundefined @@ -0,0 +1,2 @@ +curl --location --request POST 'https://medusa-url.com/admin/order-edits/{id}/request' \ +--header 'Authorization: Bearer {api_token}' diff --git a/docs/api/admin/components/schemas/address_fields.yaml b/docs/api/admin/components/schemas/address_fields.yaml new file mode 100644 index 0000000000..110810299c --- /dev/null +++ b/docs/api/admin/components/schemas/address_fields.yaml @@ -0,0 +1,53 @@ +title: Address Fields +description: Address fields used when creating/updating an address. +x-resourceId: address +properties: + company: + type: string + description: Company name + example: Acme + first_name: + type: string + description: First name + example: Arno + last_name: + type: string + description: Last name + example: Willms + address_1: + type: string + description: Address line 1 + example: 14433 Kemmer Court + address_2: + type: string + description: Address line 2 + example: Suite 369 + city: + type: string + description: City + example: South Geoffreyview + country_code: + type: string + description: The 2 character ISO code of the country in lower case + externalDocs: + url: >- + https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + example: st + province: + type: string + description: Province + example: Kentucky + postal_code: + type: string + description: Postal Code + example: 72093 + phone: + type: string + description: Phone Number + example: 16128234334802 + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/admin/components/schemas/line_item.yaml b/docs/api/admin/components/schemas/line_item.yaml index 32174752a2..cdb06694a9 100644 --- a/docs/api/admin/components/schemas/line_item.yaml +++ b/docs/api/admin/components/schemas/line_item.yaml @@ -160,6 +160,15 @@ properties: includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean + original_item_id: + description: '[EXPERIMENTAL] The id of the original line item' + type: string + order_edit_id: + description: '[EXPERIMENTAL] The ID of the order edit to which a cloned item belongs' + type: string + order_edit: + description: '[EXPERIMENTAL] The order edit joined' + type: object created_at: type: string description: The date with timezone at which the resource was created. diff --git a/docs/api/admin/components/schemas/order_edit.yaml b/docs/api/admin/components/schemas/order_edit.yaml index b050c5a36d..fdcb17fccd 100644 --- a/docs/api/admin/components/schemas/order_edit.yaml +++ b/docs/api/admin/components/schemas/order_edit.yaml @@ -60,12 +60,24 @@ properties: type: string subtotal: type: integer - description: The subtotal for line items computed from changes. + description: The total of subtotal example: 8000 discount_total: type: integer description: The total of discount example: 800 + shipping_total: + type: integer + description: The total of the shipping amount + example: 800 + gift_card_total: + type: integer + description: The total of the gift card amount + example: 800 + gift_card_tax_total: + type: integer + description: The total of the gift card tax amount + example: 800 tax_total: type: integer description: The total of tax diff --git a/docs/api/admin/components/schemas/product_variant_prices_fields.yaml b/docs/api/admin/components/schemas/product_variant_prices_fields.yaml new file mode 100644 index 0000000000..aefca848a0 --- /dev/null +++ b/docs/api/admin/components/schemas/product_variant_prices_fields.yaml @@ -0,0 +1,37 @@ +title: Product Variant Prices Fields +description: Product Variants Prices Fields that are only available in some requests. +x-resourceId: product_variant_prices_fields +properties: + original_price: + type: number + description: The original price of the variant without any discounted prices applied. + calculated_price: + type: number + description: The calculated price of the variant. Can be a discounted price. + original_price_incl_tax: + type: number + description: The original price of the variant including taxes. + calculated_price_incl_tax: + type: number + description: The calculated price of the variant including taxes. + original_tax: + type: number + description: The taxes applied on the original price. + calculated_tax: + type: number + description: The taxes applied on the calculated price. + tax_rates: + type: array + description: An array of applied tax rates + items: + type: object + properties: + rate: + type: number + description: The tax rate value + name: + type: string + description: The name of the tax rate + code: + type: string + description: The code of the tax rate diff --git a/docs/api/admin/openapi.yaml b/docs/api/admin/openapi.yaml index fd909b8944..0f15dafd46 100644 --- a/docs/api/admin/openapi.yaml +++ b/docs/api/admin/openapi.yaml @@ -15,6 +15,89 @@ info: + + + ## Expanding Fields + + + In many endpoints you'll find an `expand` query parameter that can be passed + to the endpoint. You can use the `expand` query parameter to unpack an + entity's relations and return them in the response. + + + For example, when you list customers you can also retrieve their groups by + passing to the `expand` query parameter the value `groups`. + + + You can expand more than one relation by separating the relations in the + `expand` query parameter with a comma. For example, to retrieve both the + orders and the groups of a customer, pass to the `expand` query parameter + the value `groups,orders`. + + + Please note that the parameters you pass to `expand` replace any relations + that are expanded by default. + + + ## Selecting Fields + + + In many endpoints you'll find a `fields` query parameter that can be passed + to the endpoint. You can use the `fields` query parameter to specify which + fields in the entity should be returned in the response. + + + You can pass more than one field by seperating the field names in the + `fields` query parameter with a comma. + + + Only the fields you pass to `field` will be retrieved and returned in the + response. Any fields that are returned by default will not be returned in + this case. This does not affect relations. + + + For example, to only select the `title` and `description` fields of a + product, pass to the `fields` query parameter the value `title,description`. + + + ## Pagination + + + ### Query Parameters + + + In listing endpoints, such as list customers or list products, you can + control the pagination using the query parameters `limit` and `offset`. + + + `limit` is used to specify the maximum number of items that can be return in + the response. `offset` is used to specify how many items to skip before + returning the resulting entities. + + + You can use the `offset` query parameter to change between pages. For + example, if the limit is 50, at page 1 the offset should be 0; at page 2 the + offset should be 50, and so on. + + + ### Response Fields + + + In listing fields, aside from the entities retrieved, there are three + pagination-related fields returned: `count`, `limit`, and `offset`. + + + Similarly to the query parameters, `limit` is the maximum number of items + that can be returned in the response, and `field` is the number of items + that were skipped before the entities in the result. + + + `count` is the total number of available items of this entity. It can be + used to determine how many pages are there. + + + For example, if the `count` is 100 and the `limit` is 50, you can divide the + `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. license: name: MIT url: https://github.com/medusajs/medusa/blob/master/LICENSE @@ -203,6 +286,22 @@ paths: $ref: paths/notifications.yaml /notifications/{id}/resend: $ref: paths/notifications_{id}_resend.yaml + /order-edits/{id}/items: + $ref: paths/order-edits_{id}_items.yaml + /order-edits/{id}/cancel: + $ref: paths/order-edits_{id}_cancel.yaml + /order-edits/{id}/confirm: + $ref: paths/order-edits_{id}_confirm.yaml + /order-edits: + $ref: paths/order-edits.yaml + /order-edits/{id}/items/{item_id}: + $ref: paths/order-edits_{id}_items_{item_id}.yaml + /order-edits/{id}/changes/{change_id}: + $ref: paths/order-edits_{id}_changes_{change_id}.yaml + /order-edits/{id}: + $ref: paths/order-edits_{id}.yaml + /order-edits/{id}/request: + $ref: paths/order-edits_{id}_request.yaml /orders/{id}/shipping-methods: $ref: paths/orders_{id}_shipping-methods.yaml /orders/{id}/archive: diff --git a/docs/api/admin/paths/admin_draft-orders_{id}.yaml b/docs/api/admin/paths/admin_draft-orders_{id}.yaml index 6124094fd3..86de7f8599 100644 --- a/docs/api/admin/paths/admin_draft-orders_{id}.yaml +++ b/docs/api/admin/paths/admin_draft-orders_{id}.yaml @@ -31,10 +31,10 @@ post: format: email billing_address: description: The Address to be used for billing purposes. - $ref: ../components/schemas/address.yaml + $ref: ../components/schemas/address_fields.yaml shipping_address: description: The Address to be used for shipping. - $ref: ../components/schemas/address.yaml + $ref: ../components/schemas/address_fields.yaml discounts: description: An array of Discount codes to add to the Draft Order. type: array diff --git a/docs/api/admin/paths/draft-orders.yaml b/docs/api/admin/paths/draft-orders.yaml index 03a64085ec..a1ce3947a7 100644 --- a/docs/api/admin/paths/draft-orders.yaml +++ b/docs/api/admin/paths/draft-orders.yaml @@ -25,10 +25,10 @@ post: format: email billing_address: description: The Address to be used for billing purposes. - $ref: ../components/schemas/address.yaml + $ref: ../components/schemas/address_fields.yaml shipping_address: description: The Address to be used for shipping. - $ref: ../components/schemas/address.yaml + $ref: ../components/schemas/address_fields.yaml items: description: The Line Items that have been received. type: array diff --git a/docs/api/admin/paths/order-edits.yaml b/docs/api/admin/paths/order-edits.yaml new file mode 100644 index 0000000000..f8034c1443 --- /dev/null +++ b/docs/api/admin/paths/order-edits.yaml @@ -0,0 +1,40 @@ +post: + operationId: PostOrderEdits + summary: Create an OrderEdit + description: Creates an OrderEdit. + x-authenticated: true + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/order-edits_{id}.yaml b/docs/api/admin/paths/order-edits_{id}.yaml new file mode 100644 index 0000000000..86c87ffe26 --- /dev/null +++ b/docs/api/admin/paths/order-edits_{id}.yaml @@ -0,0 +1,140 @@ +delete: + operationId: DeleteOrderEditsOrderEdit + summary: Delete an Order Edit + description: Deletes an Order Edit + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}/deleteundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}/deleteundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + id: + type: string + description: The ID of the deleted Order Edit. + object: + type: string + description: The type of the object that was deleted. + format: order_edit + deleted: + type: boolean + description: Whether or not the Order Edit was deleted. + default: true + '400': + $ref: ../components/responses/400_error.yaml +get: + operationId: GetOrderEditsOrderEdit + summary: Retrieve an OrderEdit + description: Retrieves a OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}/getundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}/getundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostOrderEditsOrderEdit + summary: Updates an OrderEdit + description: Updates a OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/order-edits_{id}_cancel.yaml b/docs/api/admin/paths/order-edits_{id}_cancel.yaml new file mode 100644 index 0000000000..f69e665d76 --- /dev/null +++ b/docs/api/admin/paths/order-edits_{id}_cancel.yaml @@ -0,0 +1,43 @@ +post: + operationId: PostOrderEditsOrderEditCancel + summary: Cancel an OrderEdit + description: Cancels an OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}_cancel/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}_cancel/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml b/docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml new file mode 100644 index 0000000000..4baa154fbd --- /dev/null +++ b/docs/api/admin/paths/order-edits_{id}_changes_{change_id}.yaml @@ -0,0 +1,54 @@ +delete: + operationId: DeleteOrderEditsOrderEditItemChange + summary: Delete an Order Edit Item Change + description: Deletes an Order Edit Item Change + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete. + schema: + type: string + - in: path + name: change_id + required: true + description: The ID of the Order Edit Item Change to delete. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: >- + ../code_samples/JavaScript/order-edits_{id}_changes_{change_id}/deleteundefined + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/order-edits_{id}_changes_{change_id}/deleteundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + id: + type: string + description: The ID of the deleted Order Edit Item Change. + object: + type: string + description: The type of the object that was deleted. + format: item_change + deleted: + type: boolean + description: Whether or not the Order Edit Item Change was deleted. + default: true + '400': + $ref: ../components/responses/400_error.yaml diff --git a/docs/api/admin/paths/order-edits_{id}_confirm.yaml b/docs/api/admin/paths/order-edits_{id}_confirm.yaml new file mode 100644 index 0000000000..fad1889432 --- /dev/null +++ b/docs/api/admin/paths/order-edits_{id}_confirm.yaml @@ -0,0 +1,43 @@ +post: + operationId: PostOrderEditsOrderEditConfirm + summary: Confirms an OrderEdit + description: Confirms an OrderEdit. + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the order edit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}_confirm/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}_confirm/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/order-edits_{id}_items.yaml b/docs/api/admin/paths/order-edits_{id}_items.yaml new file mode 100644 index 0000000000..5588a9570a --- /dev/null +++ b/docs/api/admin/paths/order-edits_{id}_items.yaml @@ -0,0 +1,47 @@ +post: + operationId: PostOrderEditsEditLineItems + summary: Add an line item to an order (edit) + description: Create an OrderEdit LineItem. + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit. + schema: + type: string + x-authenticated: true + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}_items/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}_items/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml b/docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml new file mode 100644 index 0000000000..95634fe383 --- /dev/null +++ b/docs/api/admin/paths/order-edits_{id}_items_{item_id}.yaml @@ -0,0 +1,108 @@ +delete: + operationId: DeleteOrderEditsOrderEditLineItemsLineItem + summary: Delete line items from an order edit and create change item + description: Delete line items from an order edit and create change item + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to delete from. + schema: + type: string + - in: path + name: item_id + required: true + description: The ID of the order edit item to delete from order. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: >- + ../code_samples/JavaScript/order-edits_{id}_items_{item_id}/deleteundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}_items_{item_id}/deleteundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostOrderEditsEditLineItemsLineItem + summary: Create or update the order edit change holding the line item changes + description: Create or update the order edit change holding the line item changes + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to update. + schema: + type: string + - in: path + name: item_id + required: true + description: The ID of the order edit item to update. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: >- + ../code_samples/JavaScript/order-edits_{id}_items_{item_id}/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}_items_{item_id}/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/order-edits_{id}_request.yaml b/docs/api/admin/paths/order-edits_{id}_request.yaml new file mode 100644 index 0000000000..0b3d55e61d --- /dev/null +++ b/docs/api/admin/paths/order-edits_{id}_request.yaml @@ -0,0 +1,43 @@ +post: + operationId: PostOrderEditsOrderEditRequest + summary: Request order edit confirmation + description: Request customer confirmation of an Order Edit + x-authenticated: true + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit to request confirmation from. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}_request/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}_request/postundefined + security: + - api_token: [] + - cookie_auth: [] + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/admin/paths/orders_{id}.yaml b/docs/api/admin/paths/orders_{id}.yaml index 91ff4c9e2a..2747c45139 100644 --- a/docs/api/admin/paths/orders_{id}.yaml +++ b/docs/api/admin/paths/orders_{id}.yaml @@ -68,11 +68,11 @@ post: billing_address: description: Billing address anyOf: - - $ref: ../components/schemas/address.yaml + - $ref: ../components/schemas/address_fields.yaml shipping_address: description: Shipping address anyOf: - - $ref: ../components/schemas/address.yaml + - $ref: ../components/schemas/address_fields.yaml items: description: The Line Items for the order type: array diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json index 2981788b89..2c871d4971 100644 --- a/docs/api/store-spec3.json +++ b/docs/api/store-spec3.json @@ -15,6 +15,89 @@ info: + + + ## Expanding Fields + + + In many endpoints you'll find an `expand` query parameter that can be passed + to the endpoint. You can use the `expand` query parameter to unpack an + entity's relations and return them in the response. + + + For example, when you list customers you can also retrieve their groups by + passing to the `expand` query parameter the value `groups`. + + + You can expand more than one relation by separating the relations in the + `expand` query parameter with a comma. For example, to retrieve both the + orders and the groups of a customer, pass to the `expand` query parameter + the value `groups,orders`. + + + Please note that the parameters you pass to `expand` replace any relations + that are expanded by default. + + + ## Selecting Fields + + + In many endpoints you'll find a `fields` query parameter that can be passed + to the endpoint. You can use the `fields` query parameter to specify which + fields in the entity should be returned in the response. + + + You can pass more than one field by seperating the field names in the + `fields` query parameter with a comma. + + + Only the fields you pass to `field` will be retrieved and returned in the + response. Any fields that are returned by default will not be returned in + this case. This does not affect relations. + + + For example, to only select the `title` and `description` fields of a + product, pass to the `fields` query parameter the value `title,description`. + + + ## Pagination + + + ### Query Parameters + + + In listing endpoints, such as list customers or list products, you can + control the pagination using the query parameters `limit` and `offset`. + + + `limit` is used to specify the maximum number of items that can be return in + the response. `offset` is used to specify how many items to skip before + returning the resulting entities. + + + You can use the `offset` query parameter to change between pages. For + example, if the limit is 50, at page 1 the offset should be 0; at page 2 the + offset should be 50, and so on. + + + ### Response Fields + + + In listing fields, aside from the entities retrieved, there are three + pagination-related fields returned: `count`, `limit`, and `offset`. + + + Similarly to the query parameters, `limit` is the maximum number of items + that can be returned in the response, and `field` is the number of items + that were skipped before the entities in the result. + + + `count` is the total number of available items of this entity. It can be + used to determine how many pages are there. + + + For example, if the `count` is 100 and the `limit` is 50, you can divide the + `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. license: name: MIT url: 'https://github.com/medusajs/medusa/blob/master/LICENSE' @@ -1542,8 +1625,16 @@ paths: properties: address: description: The Address to add to the Customer. - anyOf: - - $ref: '#/components/schemas/address' + allOf: + - $ref: '#/components/schemas/address_fields' + - type: object + required: + - first_name + - last_name + - address_1 + - city + - country_code + - postal_code x-codeSamples: - lang: JavaScript label: JS Client @@ -1802,7 +1893,7 @@ paths: application/json: schema: anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/address_fields' x-codeSamples: - lang: JavaScript label: JS Client @@ -1934,7 +2025,7 @@ paths: billing_address: description: The Address to be used for billing purposes. anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/address_fields' description: The full billing address object - type: string description: The ID of an existing billing address @@ -2505,6 +2596,166 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/order-edits/{id}/complete': + post: + operationId: PostOrderEditsOrderEditComplete + summary: Completes an OrderEdit + description: Completes an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdit.complete(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/order-edits/{id}/complete' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/decline': + post: + operationId: PostOrderEditsOrderEditDecline + summary: Decline an OrderEdit + description: Declines an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + declined_reason: + type: string + description: The reason for declining the OrderEdit. + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdit.decline(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id); + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/order-edits/{id}/decline' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}': + get: + operationId: GetOrderEditsOrderEdit + summary: Retrieve an OrderEdit + description: Retrieves a OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdit.retrieve(orderEditId) + + .then(({ order_edit }) => { + console.log(order_edit.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/order-edits/{id}' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' '/orders/cart/{cart_id}': get: operationId: GetOrdersOrderCartId @@ -2751,7 +3002,17 @@ paths: schema: properties: product: - $ref: '#/components/schemas/product' + allOf: + - $ref: '#/components/schemas/product' + - type: object + properties: + variants: + type: array + items: + allOf: + - $ref: '#/components/schemas/product_variant' + - $ref: >- + #/components/schemas/product_variant_prices_fields '400': $ref: '#/components/responses/400_error' '404': @@ -2930,7 +3191,17 @@ paths: products: type: array items: - $ref: '#/components/schemas/product' + allOf: + - $ref: '#/components/schemas/product' + - type: object + properties: + variants: + type: array + items: + allOf: + - $ref: '#/components/schemas/product_variant' + - $ref: >- + #/components/schemas/product_variant_prices_fields count: type: integer description: The total number of items available @@ -3732,7 +4003,9 @@ paths: schema: properties: variant: - $ref: '#/components/schemas/product_variant' + allOf: + - $ref: '#/components/schemas/product_variant' + - $ref: '#/components/schemas/product_variant_prices_fields' '400': $ref: '#/components/responses/400_error' '404': @@ -3828,7 +4101,9 @@ paths: variants: type: array items: - $ref: '#/components/schemas/product_variant' + allOf: + - $ref: '#/components/schemas/product_variant' + - $ref: '#/components/schemas/product_variant_prices_fields' '400': $ref: '#/components/responses/400_error' '404': @@ -4040,6 +4315,60 @@ components: Where `{sid}` is the value of `connect.sid` that you copied. schemas: + address_fields: + title: Address Fields + description: Address fields used when creating/updating an address. + x-resourceId: address + properties: + company: + type: string + description: Company name + example: Acme + first_name: + type: string + description: First name + example: Arno + last_name: + type: string + description: Last name + example: Willms + address_1: + type: string + description: Address line 1 + example: 14433 Kemmer Court + address_2: + type: string + description: Address line 2 + example: Suite 369 + city: + type: string + description: City + example: South Geoffreyview + country_code: + type: string + description: The 2 character ISO code of the country in lower case + externalDocs: + url: >- + https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + example: st + province: + type: string + description: Province + example: Kentucky + postal_code: + type: string + description: Postal Code + example: 72093 + phone: + type: string + description: Phone Number + example: 16128234334802 + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white address: title: Address description: An address. @@ -6174,6 +6503,17 @@ components: includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean + original_item_id: + description: '[EXPERIMENTAL] The id of the original line item' + type: string + order_edit_id: + description: >- + [EXPERIMENTAL] The ID of the order edit to which a cloned item + belongs + type: string + order_edit: + description: '[EXPERIMENTAL] The order edit joined' + type: object created_at: type: string description: The date with timezone at which the resource was created. @@ -6579,12 +6919,24 @@ components: type: string subtotal: type: integer - description: The subtotal for line items computed from changes. + description: The total of subtotal example: 8000 discount_total: type: integer description: The total of discount example: 800 + shipping_total: + type: integer + description: The total of the shipping amount + example: 800 + gift_card_total: + type: integer + description: The total of the gift card amount + example: 800 + gift_card_tax_total: + type: integer + description: The total of the gift card tax amount + example: 800 tax_total: type: integer description: The total of tax @@ -7643,6 +7995,46 @@ components: description: An optional key-value map with additional details example: car: white + product_variant_prices_fields: + title: Product Variant Prices Fields + description: Product Variants Prices Fields that are only available in some requests. + x-resourceId: product_variant_prices_fields + properties: + original_price: + type: number + description: >- + The original price of the variant without any discounted prices + applied. + calculated_price: + type: number + description: The calculated price of the variant. Can be a discounted price. + original_price_incl_tax: + type: number + description: The original price of the variant including taxes. + calculated_price_incl_tax: + type: number + description: The calculated price of the variant including taxes. + original_tax: + type: number + description: The taxes applied on the original price. + calculated_tax: + type: number + description: The taxes applied on the calculated price. + tax_rates: + type: array + description: An array of applied tax rates + items: + type: object + properties: + rate: + type: number + description: The tax rate value + name: + type: string + description: The name of the tax rate + code: + type: string + description: The code of the tax rate product: title: Product description: >- diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml index 2981788b89..2c871d4971 100644 --- a/docs/api/store-spec3.yaml +++ b/docs/api/store-spec3.yaml @@ -15,6 +15,89 @@ info: + + + ## Expanding Fields + + + In many endpoints you'll find an `expand` query parameter that can be passed + to the endpoint. You can use the `expand` query parameter to unpack an + entity's relations and return them in the response. + + + For example, when you list customers you can also retrieve their groups by + passing to the `expand` query parameter the value `groups`. + + + You can expand more than one relation by separating the relations in the + `expand` query parameter with a comma. For example, to retrieve both the + orders and the groups of a customer, pass to the `expand` query parameter + the value `groups,orders`. + + + Please note that the parameters you pass to `expand` replace any relations + that are expanded by default. + + + ## Selecting Fields + + + In many endpoints you'll find a `fields` query parameter that can be passed + to the endpoint. You can use the `fields` query parameter to specify which + fields in the entity should be returned in the response. + + + You can pass more than one field by seperating the field names in the + `fields` query parameter with a comma. + + + Only the fields you pass to `field` will be retrieved and returned in the + response. Any fields that are returned by default will not be returned in + this case. This does not affect relations. + + + For example, to only select the `title` and `description` fields of a + product, pass to the `fields` query parameter the value `title,description`. + + + ## Pagination + + + ### Query Parameters + + + In listing endpoints, such as list customers or list products, you can + control the pagination using the query parameters `limit` and `offset`. + + + `limit` is used to specify the maximum number of items that can be return in + the response. `offset` is used to specify how many items to skip before + returning the resulting entities. + + + You can use the `offset` query parameter to change between pages. For + example, if the limit is 50, at page 1 the offset should be 0; at page 2 the + offset should be 50, and so on. + + + ### Response Fields + + + In listing fields, aside from the entities retrieved, there are three + pagination-related fields returned: `count`, `limit`, and `offset`. + + + Similarly to the query parameters, `limit` is the maximum number of items + that can be returned in the response, and `field` is the number of items + that were skipped before the entities in the result. + + + `count` is the total number of available items of this entity. It can be + used to determine how many pages are there. + + + For example, if the `count` is 100 and the `limit` is 50, you can divide the + `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. license: name: MIT url: 'https://github.com/medusajs/medusa/blob/master/LICENSE' @@ -1542,8 +1625,16 @@ paths: properties: address: description: The Address to add to the Customer. - anyOf: - - $ref: '#/components/schemas/address' + allOf: + - $ref: '#/components/schemas/address_fields' + - type: object + required: + - first_name + - last_name + - address_1 + - city + - country_code + - postal_code x-codeSamples: - lang: JavaScript label: JS Client @@ -1802,7 +1893,7 @@ paths: application/json: schema: anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/address_fields' x-codeSamples: - lang: JavaScript label: JS Client @@ -1934,7 +2025,7 @@ paths: billing_address: description: The Address to be used for billing purposes. anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/address_fields' description: The full billing address object - type: string description: The ID of an existing billing address @@ -2505,6 +2596,166 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + '/order-edits/{id}/complete': + post: + operationId: PostOrderEditsOrderEditComplete + summary: Completes an OrderEdit + description: Completes an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdit.complete(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/order-edits/{id}/complete' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}/decline': + post: + operationId: PostOrderEditsOrderEditDecline + summary: Decline an OrderEdit + description: Declines an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + declined_reason: + type: string + description: The reason for declining the OrderEdit. + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdit.decline(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id); + }) + - lang: Shell + label: cURL + source: > + curl --location --request POST + 'https://medusa-url.com/store/order-edits/{id}/decline' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '500': + $ref: '#/components/responses/500_error' + '/order-edits/{id}': + get: + operationId: GetOrderEditsOrderEdit + summary: Retrieve an OrderEdit + description: Retrieves a OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: > + import Medusa from "@medusajs/medusa-js" + + const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: + 3 }) + + medusa.orderEdit.retrieve(orderEditId) + + .then(({ order_edit }) => { + console.log(order_edit.id); + }); + - lang: Shell + label: cURL + source: > + curl --location --request GET + 'https://medusa-url.com/store/order-edits/{id}' + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: '#/components/schemas/order_edit' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' '/orders/cart/{cart_id}': get: operationId: GetOrdersOrderCartId @@ -2751,7 +3002,17 @@ paths: schema: properties: product: - $ref: '#/components/schemas/product' + allOf: + - $ref: '#/components/schemas/product' + - type: object + properties: + variants: + type: array + items: + allOf: + - $ref: '#/components/schemas/product_variant' + - $ref: >- + #/components/schemas/product_variant_prices_fields '400': $ref: '#/components/responses/400_error' '404': @@ -2930,7 +3191,17 @@ paths: products: type: array items: - $ref: '#/components/schemas/product' + allOf: + - $ref: '#/components/schemas/product' + - type: object + properties: + variants: + type: array + items: + allOf: + - $ref: '#/components/schemas/product_variant' + - $ref: >- + #/components/schemas/product_variant_prices_fields count: type: integer description: The total number of items available @@ -3732,7 +4003,9 @@ paths: schema: properties: variant: - $ref: '#/components/schemas/product_variant' + allOf: + - $ref: '#/components/schemas/product_variant' + - $ref: '#/components/schemas/product_variant_prices_fields' '400': $ref: '#/components/responses/400_error' '404': @@ -3828,7 +4101,9 @@ paths: variants: type: array items: - $ref: '#/components/schemas/product_variant' + allOf: + - $ref: '#/components/schemas/product_variant' + - $ref: '#/components/schemas/product_variant_prices_fields' '400': $ref: '#/components/responses/400_error' '404': @@ -4040,6 +4315,60 @@ components: Where `{sid}` is the value of `connect.sid` that you copied. schemas: + address_fields: + title: Address Fields + description: Address fields used when creating/updating an address. + x-resourceId: address + properties: + company: + type: string + description: Company name + example: Acme + first_name: + type: string + description: First name + example: Arno + last_name: + type: string + description: Last name + example: Willms + address_1: + type: string + description: Address line 1 + example: 14433 Kemmer Court + address_2: + type: string + description: Address line 2 + example: Suite 369 + city: + type: string + description: City + example: South Geoffreyview + country_code: + type: string + description: The 2 character ISO code of the country in lower case + externalDocs: + url: >- + https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + example: st + province: + type: string + description: Province + example: Kentucky + postal_code: + type: string + description: Postal Code + example: 72093 + phone: + type: string + description: Phone Number + example: 16128234334802 + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white address: title: Address description: An address. @@ -6174,6 +6503,17 @@ components: includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean + original_item_id: + description: '[EXPERIMENTAL] The id of the original line item' + type: string + order_edit_id: + description: >- + [EXPERIMENTAL] The ID of the order edit to which a cloned item + belongs + type: string + order_edit: + description: '[EXPERIMENTAL] The order edit joined' + type: object created_at: type: string description: The date with timezone at which the resource was created. @@ -6579,12 +6919,24 @@ components: type: string subtotal: type: integer - description: The subtotal for line items computed from changes. + description: The total of subtotal example: 8000 discount_total: type: integer description: The total of discount example: 800 + shipping_total: + type: integer + description: The total of the shipping amount + example: 800 + gift_card_total: + type: integer + description: The total of the gift card amount + example: 800 + gift_card_tax_total: + type: integer + description: The total of the gift card tax amount + example: 800 tax_total: type: integer description: The total of tax @@ -7643,6 +7995,46 @@ components: description: An optional key-value map with additional details example: car: white + product_variant_prices_fields: + title: Product Variant Prices Fields + description: Product Variants Prices Fields that are only available in some requests. + x-resourceId: product_variant_prices_fields + properties: + original_price: + type: number + description: >- + The original price of the variant without any discounted prices + applied. + calculated_price: + type: number + description: The calculated price of the variant. Can be a discounted price. + original_price_incl_tax: + type: number + description: The original price of the variant including taxes. + calculated_price_incl_tax: + type: number + description: The calculated price of the variant including taxes. + original_tax: + type: number + description: The taxes applied on the original price. + calculated_tax: + type: number + description: The taxes applied on the calculated price. + tax_rates: + type: array + description: An array of applied tax rates + items: + type: object + properties: + rate: + type: number + description: The tax rate value + name: + type: string + description: The name of the tax rate + code: + type: string + description: The code of the tax rate product: title: Product description: >- diff --git a/docs/api/store/code_samples/JavaScript/order-edits_{id}/getundefined b/docs/api/store/code_samples/JavaScript/order-edits_{id}/getundefined new file mode 100644 index 0000000000..f77c2b0a27 --- /dev/null +++ b/docs/api/store/code_samples/JavaScript/order-edits_{id}/getundefined @@ -0,0 +1,6 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +medusa.orderEdit.retrieve(orderEditId) +.then(({ order_edit }) => { + console.log(order_edit.id); +}); diff --git a/docs/api/store/code_samples/JavaScript/order-edits_{id}_complete/postundefined b/docs/api/store/code_samples/JavaScript/order-edits_{id}_complete/postundefined new file mode 100644 index 0000000000..ee0fa54b93 --- /dev/null +++ b/docs/api/store/code_samples/JavaScript/order-edits_{id}_complete/postundefined @@ -0,0 +1,6 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +medusa.orderEdit.complete(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id) + }) diff --git a/docs/api/store/code_samples/JavaScript/order-edits_{id}_decline/postundefined b/docs/api/store/code_samples/JavaScript/order-edits_{id}_decline/postundefined new file mode 100644 index 0000000000..f3edf50fc7 --- /dev/null +++ b/docs/api/store/code_samples/JavaScript/order-edits_{id}_decline/postundefined @@ -0,0 +1,6 @@ +import Medusa from "@medusajs/medusa-js" +const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) +medusa.orderEdit.decline(orderEditId) + .then(({ order_edit }) => { + console.log(order_edit.id); + }) diff --git a/docs/api/store/code_samples/Shell/order-edits_{id}/getundefined b/docs/api/store/code_samples/Shell/order-edits_{id}/getundefined new file mode 100644 index 0000000000..10abf0b797 --- /dev/null +++ b/docs/api/store/code_samples/Shell/order-edits_{id}/getundefined @@ -0,0 +1 @@ +curl --location --request GET 'https://medusa-url.com/store/order-edits/{id}' diff --git a/docs/api/store/code_samples/Shell/order-edits_{id}_complete/postundefined b/docs/api/store/code_samples/Shell/order-edits_{id}_complete/postundefined new file mode 100644 index 0000000000..4fbcea1656 --- /dev/null +++ b/docs/api/store/code_samples/Shell/order-edits_{id}_complete/postundefined @@ -0,0 +1 @@ +curl --location --request POST 'https://medusa-url.com/store/order-edits/{id}/complete' diff --git a/docs/api/store/code_samples/Shell/order-edits_{id}_decline/postundefined b/docs/api/store/code_samples/Shell/order-edits_{id}_decline/postundefined new file mode 100644 index 0000000000..3fdbfd7094 --- /dev/null +++ b/docs/api/store/code_samples/Shell/order-edits_{id}_decline/postundefined @@ -0,0 +1 @@ +curl --location --request POST 'https://medusa-url.com/store/order-edits/{id}/decline' diff --git a/docs/api/store/components/schemas/address_fields.yaml b/docs/api/store/components/schemas/address_fields.yaml new file mode 100644 index 0000000000..110810299c --- /dev/null +++ b/docs/api/store/components/schemas/address_fields.yaml @@ -0,0 +1,53 @@ +title: Address Fields +description: Address fields used when creating/updating an address. +x-resourceId: address +properties: + company: + type: string + description: Company name + example: Acme + first_name: + type: string + description: First name + example: Arno + last_name: + type: string + description: Last name + example: Willms + address_1: + type: string + description: Address line 1 + example: 14433 Kemmer Court + address_2: + type: string + description: Address line 2 + example: Suite 369 + city: + type: string + description: City + example: South Geoffreyview + country_code: + type: string + description: The 2 character ISO code of the country in lower case + externalDocs: + url: >- + https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + example: st + province: + type: string + description: Province + example: Kentucky + postal_code: + type: string + description: Postal Code + example: 72093 + phone: + type: string + description: Phone Number + example: 16128234334802 + metadata: + type: object + description: An optional key-value map with additional details + example: + car: white diff --git a/docs/api/store/components/schemas/line_item.yaml b/docs/api/store/components/schemas/line_item.yaml index 32174752a2..cdb06694a9 100644 --- a/docs/api/store/components/schemas/line_item.yaml +++ b/docs/api/store/components/schemas/line_item.yaml @@ -160,6 +160,15 @@ properties: includes_tax: description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax' type: boolean + original_item_id: + description: '[EXPERIMENTAL] The id of the original line item' + type: string + order_edit_id: + description: '[EXPERIMENTAL] The ID of the order edit to which a cloned item belongs' + type: string + order_edit: + description: '[EXPERIMENTAL] The order edit joined' + type: object created_at: type: string description: The date with timezone at which the resource was created. diff --git a/docs/api/store/components/schemas/order_edit.yaml b/docs/api/store/components/schemas/order_edit.yaml index b050c5a36d..fdcb17fccd 100644 --- a/docs/api/store/components/schemas/order_edit.yaml +++ b/docs/api/store/components/schemas/order_edit.yaml @@ -60,12 +60,24 @@ properties: type: string subtotal: type: integer - description: The subtotal for line items computed from changes. + description: The total of subtotal example: 8000 discount_total: type: integer description: The total of discount example: 800 + shipping_total: + type: integer + description: The total of the shipping amount + example: 800 + gift_card_total: + type: integer + description: The total of the gift card amount + example: 800 + gift_card_tax_total: + type: integer + description: The total of the gift card tax amount + example: 800 tax_total: type: integer description: The total of tax diff --git a/docs/api/store/components/schemas/product_variant_prices_fields.yaml b/docs/api/store/components/schemas/product_variant_prices_fields.yaml new file mode 100644 index 0000000000..aefca848a0 --- /dev/null +++ b/docs/api/store/components/schemas/product_variant_prices_fields.yaml @@ -0,0 +1,37 @@ +title: Product Variant Prices Fields +description: Product Variants Prices Fields that are only available in some requests. +x-resourceId: product_variant_prices_fields +properties: + original_price: + type: number + description: The original price of the variant without any discounted prices applied. + calculated_price: + type: number + description: The calculated price of the variant. Can be a discounted price. + original_price_incl_tax: + type: number + description: The original price of the variant including taxes. + calculated_price_incl_tax: + type: number + description: The calculated price of the variant including taxes. + original_tax: + type: number + description: The taxes applied on the original price. + calculated_tax: + type: number + description: The taxes applied on the calculated price. + tax_rates: + type: array + description: An array of applied tax rates + items: + type: object + properties: + rate: + type: number + description: The tax rate value + name: + type: string + description: The name of the tax rate + code: + type: string + description: The code of the tax rate diff --git a/docs/api/store/openapi.yaml b/docs/api/store/openapi.yaml index cdef601bef..502e0635a4 100644 --- a/docs/api/store/openapi.yaml +++ b/docs/api/store/openapi.yaml @@ -15,6 +15,89 @@ info: + + + ## Expanding Fields + + + In many endpoints you'll find an `expand` query parameter that can be passed + to the endpoint. You can use the `expand` query parameter to unpack an + entity's relations and return them in the response. + + + For example, when you list customers you can also retrieve their groups by + passing to the `expand` query parameter the value `groups`. + + + You can expand more than one relation by separating the relations in the + `expand` query parameter with a comma. For example, to retrieve both the + orders and the groups of a customer, pass to the `expand` query parameter + the value `groups,orders`. + + + Please note that the parameters you pass to `expand` replace any relations + that are expanded by default. + + + ## Selecting Fields + + + In many endpoints you'll find a `fields` query parameter that can be passed + to the endpoint. You can use the `fields` query parameter to specify which + fields in the entity should be returned in the response. + + + You can pass more than one field by seperating the field names in the + `fields` query parameter with a comma. + + + Only the fields you pass to `field` will be retrieved and returned in the + response. Any fields that are returned by default will not be returned in + this case. This does not affect relations. + + + For example, to only select the `title` and `description` fields of a + product, pass to the `fields` query parameter the value `title,description`. + + + ## Pagination + + + ### Query Parameters + + + In listing endpoints, such as list customers or list products, you can + control the pagination using the query parameters `limit` and `offset`. + + + `limit` is used to specify the maximum number of items that can be return in + the response. `offset` is used to specify how many items to skip before + returning the resulting entities. + + + You can use the `offset` query parameter to change between pages. For + example, if the limit is 50, at page 1 the offset should be 0; at page 2 the + offset should be 50, and so on. + + + ### Response Fields + + + In listing fields, aside from the entities retrieved, there are three + pagination-related fields returned: `count`, `limit`, and `offset`. + + + Similarly to the query parameters, `limit` is the maximum number of items + that can be returned in the response, and `field` is the number of items + that were skipped before the entities in the result. + + + `count` is the total number of available items of this entity. It can be + used to determine how many pages are there. + + + For example, if the `count` is 100 and the `limit` is 50, you can divide the + `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. license: name: MIT url: https://github.com/medusajs/medusa/blob/master/LICENSE @@ -112,6 +195,12 @@ paths: $ref: paths/customers_password-reset.yaml /gift-cards/{code}: $ref: paths/gift-cards_{code}.yaml + /order-edits/{id}/complete: + $ref: paths/order-edits_{id}_complete.yaml + /order-edits/{id}/decline: + $ref: paths/order-edits_{id}_decline.yaml + /order-edits/{id}: + $ref: paths/order-edits_{id}.yaml /orders/cart/{cart_id}: $ref: paths/orders_cart_{cart_id}.yaml /orders/{id}: diff --git a/docs/api/store/paths/customers_me.yaml b/docs/api/store/paths/customers_me.yaml index 936f7dc9d1..cb815e3453 100644 --- a/docs/api/store/paths/customers_me.yaml +++ b/docs/api/store/paths/customers_me.yaml @@ -58,7 +58,7 @@ post: billing_address: description: The Address to be used for billing purposes. anyOf: - - $ref: ../components/schemas/address.yaml + - $ref: ../components/schemas/address_fields.yaml description: The full billing address object - type: string description: The ID of an existing billing address diff --git a/docs/api/store/paths/customers_me_addresses.yaml b/docs/api/store/paths/customers_me_addresses.yaml index 75f59ca824..f9b39fdd01 100644 --- a/docs/api/store/paths/customers_me_addresses.yaml +++ b/docs/api/store/paths/customers_me_addresses.yaml @@ -12,8 +12,16 @@ post: properties: address: description: The Address to add to the Customer. - anyOf: - - $ref: ../components/schemas/address.yaml + allOf: + - $ref: ../components/schemas/address_fields.yaml + - type: object + required: + - first_name + - last_name + - address_1 + - city + - country_code + - postal_code x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/store/paths/customers_me_addresses_{address_id}.yaml b/docs/api/store/paths/customers_me_addresses_{address_id}.yaml index 62966310a5..763000bbe6 100644 --- a/docs/api/store/paths/customers_me_addresses_{address_id}.yaml +++ b/docs/api/store/paths/customers_me_addresses_{address_id}.yaml @@ -63,7 +63,7 @@ post: application/json: schema: anyOf: - - $ref: ../components/schemas/address.yaml + - $ref: ../components/schemas/address_fields.yaml x-codeSamples: - lang: JavaScript label: JS Client diff --git a/docs/api/store/paths/order-edits_{id}.yaml b/docs/api/store/paths/order-edits_{id}.yaml new file mode 100644 index 0000000000..e983c1a575 --- /dev/null +++ b/docs/api/store/paths/order-edits_{id}.yaml @@ -0,0 +1,43 @@ +get: + operationId: GetOrderEditsOrderEdit + summary: Retrieve an OrderEdit + description: Retrieves a OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}/getundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}/getundefined + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/store/paths/order-edits_{id}_complete.yaml b/docs/api/store/paths/order-edits_{id}_complete.yaml new file mode 100644 index 0000000000..08c3a38bdb --- /dev/null +++ b/docs/api/store/paths/order-edits_{id}_complete.yaml @@ -0,0 +1,39 @@ +post: + operationId: PostOrderEditsOrderEditComplete + summary: Completes an OrderEdit + description: Completes an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the Order Edit. + schema: + type: string + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}_complete/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}_complete/postundefined + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/store/paths/order-edits_{id}_decline.yaml b/docs/api/store/paths/order-edits_{id}_decline.yaml new file mode 100644 index 0000000000..2cc3593a92 --- /dev/null +++ b/docs/api/store/paths/order-edits_{id}_decline.yaml @@ -0,0 +1,47 @@ +post: + operationId: PostOrderEditsOrderEditDecline + summary: Decline an OrderEdit + description: Declines an OrderEdit. + parameters: + - in: path + name: id + required: true + description: The ID of the OrderEdit. + schema: + type: string + requestBody: + content: + application/json: + schema: + properties: + declined_reason: + type: string + description: The reason for declining the OrderEdit. + x-codeSamples: + - lang: JavaScript + label: JS Client + source: + $ref: ../code_samples/JavaScript/order-edits_{id}_decline/postundefined + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/order-edits_{id}_decline/postundefined + tags: + - OrderEdit + responses: + '200': + description: OK + content: + application/json: + schema: + properties: + order_edit: + $ref: ../components/schemas/order_edit.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/docs/api/store/paths/products.yaml b/docs/api/store/paths/products.yaml index 4599ce3663..f347b4f4c0 100644 --- a/docs/api/store/paths/products.yaml +++ b/docs/api/store/paths/products.yaml @@ -155,7 +155,17 @@ get: products: type: array items: - $ref: ../components/schemas/product.yaml + allOf: + - $ref: ../components/schemas/product.yaml + - type: object + properties: + variants: + type: array + items: + allOf: + - $ref: ../components/schemas/product_variant.yaml + - $ref: >- + ../components/schemas/product_variant_prices_fields.yaml count: type: integer description: The total number of items available diff --git a/docs/api/store/paths/products_{id}.yaml b/docs/api/store/paths/products_{id}.yaml index 9f00727708..5c84a67c8d 100644 --- a/docs/api/store/paths/products_{id}.yaml +++ b/docs/api/store/paths/products_{id}.yaml @@ -52,7 +52,17 @@ get: schema: properties: product: - $ref: ../components/schemas/product.yaml + allOf: + - $ref: ../components/schemas/product.yaml + - type: object + properties: + variants: + type: array + items: + allOf: + - $ref: ../components/schemas/product_variant.yaml + - $ref: >- + ../components/schemas/product_variant_prices_fields.yaml '400': $ref: ../components/responses/400_error.yaml '404': diff --git a/docs/api/store/paths/variants.yaml b/docs/api/store/paths/variants.yaml index d9ed51e234..f4f6f213d3 100644 --- a/docs/api/store/paths/variants.yaml +++ b/docs/api/store/paths/variants.yaml @@ -79,7 +79,9 @@ get: variants: type: array items: - $ref: ../components/schemas/product_variant.yaml + allOf: + - $ref: ../components/schemas/product_variant.yaml + - $ref: ../components/schemas/product_variant_prices_fields.yaml '400': $ref: ../components/responses/400_error.yaml '404': diff --git a/docs/api/store/paths/variants_{variant_id}.yaml b/docs/api/store/paths/variants_{variant_id}.yaml index 2b32144567..9611568690 100644 --- a/docs/api/store/paths/variants_{variant_id}.yaml +++ b/docs/api/store/paths/variants_{variant_id}.yaml @@ -44,7 +44,9 @@ get: schema: properties: variant: - $ref: ../components/schemas/product_variant.yaml + allOf: + - $ref: ../components/schemas/product_variant.yaml + - $ref: ../components/schemas/product_variant_prices_fields.yaml '400': $ref: ../components/responses/400_error.yaml '404': diff --git a/docs/content/advanced/admin/import-prices.mdx b/docs/content/advanced/admin/import-prices.mdx new file mode 100644 index 0000000000..f5c787ccee --- /dev/null +++ b/docs/content/advanced/admin/import-prices.mdx @@ -0,0 +1,306 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# How to Import Prices + +In this document, you’ll learn how to import prices into a price list using the Admin APIs. + +## Overview + +Using Medusa’s [Batch Job Admin APIs](https://docs.medusajs.com/api/admin/#tag/Batch-Job), you can import prices into a price list. + +:::caution + +Importing prices into a price list removes all existing prices in the price list and adds the imported prices. + +::: + +## Prerequisites + +### Medusa Components + +It is assumed that you already have a Medusa server installed and set up. If not, you can follow our [quickstart guide](../../quickstart/quick-start.md) to get started. + +### Redis + +Redis is required for batch jobs to work. Make sure you [install Redis](../../tutorial/0-set-up-your-development-environment.mdx#redis) and [configure it with your Medusa server](./../../usage/configurations.md#redis). + +### File Service Plugin + +Part of the process of importing prices is uploading a CSV file. This requires a file service plugin to be installed on your server. If you don’t have any installed, you can install one of the following options: + +- [MinIO](../../add-plugins/minio.md) (At least version `1.1.0`) +- [Spaces](../../add-plugins/spaces.md) + +### CSV File + +You must have a CSV file that you will use to import prices into your Medusa server. You can check [this CSV example file](https://medusa-doc-files.s3.amazonaws.com/price-list-import-template.csv) to see which format is required for your import. + +### JS Client + +This guide includes code snippets to send requests to your Medusa server using Medusa’s JS Client, JavaScript’s Fetch API, or cURL. + +If you follow the JS Client code blocks, it’s assumed you already have [Medusa’s JS Client](../../js-client/overview.md) installed and have [created an instance of the client](../../js-client/overview.md#configuration). + +### Authenticated Admin User + +You must be an authenticated admin user before following along with the steps in the tutorial. + +You can learn more about [authenticating as an admin user in the API reference](https://docs.medusajs.com/api/admin/#section/Authentication). + +### Created Price List + +Before importing the prices, you must have a price list to import them to. + +You can use the [Create Price List](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/PostPriceListsPriceList) endpoint, or follow the [how-to guide to learn how to create and manage price lists using the Admin API](../backend/price-lists/use-api.mdx). + +## 1. Upload CSV File + +The first step is to upload the CSV file to import prices from. + +You can do that by sending the following request to the [Upload Files](https://docs.medusajs.com/api/admin/#tag/Upload/operation/PostUploads) endpoint: + + + + +```jsx +medusa.admin.uploads.create(file) //file is an instance of File +.then(({ uploads }) => { + const key = uploads[0].key; +}); +``` + + + + +```jsx +const formData = new FormData(); +formData.append('files', file); //file is an instance of File + +fetch(`/admin/uploads`, { + method: 'POST', + headers: { + 'Content-Type': 'multipart/form-data', + }, + body: formData +}) +.then((response) => response.json()) +.then(({ uploads }) => { + const key = uploads[0].key; +}); +``` + + + + +```bash +curl --location --request POST '/admin/uploads' \ + --header 'Authorization: Bearer {api_token}' \ + --header 'Content-Type: text/csv' \ + --form 'files=@""' +``` + + + + +This request returns an array of uploads. Each item in the array is an object that includes the properties `url` and `key`. You’ll need the `key` to import the prices next. + +## 2. Create a Batch Job for Prices Import + +To start a new price import, you must create a batch job. + +You can do that by sending the following request to the [Create a Batch Job](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs) endpoint: + + + + +```jsx +medusa.admin.batchJobs.create({ + type: 'price-list-import', + context: { + fileKey: key, //obtained from previous step + price_list_id + }, + dry_run: true +}) +.then(( batch_job ) => { + console.log(batch_job.status); +}); +``` + + + + +```jsx +fetch(`/admin/batch-jobs`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + type: 'price-list-import', + context: { + fileKey: key, //obtained from previous step + price_list_id + }, + dry_run: true + }) +}) +.then((response) => response.json()) +.then(({ batch_job }) => { + console.log(batch_job.status); +}); +``` + + + + +```bash +curl --location --request POST '/admin/batch-jobs' \ +--header 'Authorization: Bearer {api_token}' \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "type": "price-list-import", + "context": { + "fileKey": "", + "price_list_id": "" + }, + "dry_run": true +}' +# is the key you obtained from the previous step +# is the ID of the price list to import prices into +``` + + + + +In the body of the request, you must pass the following parameters: + +- `type`: Batch jobs can be of different types. For price imports, the type should always be `price-list-import`. +- `context`: An object that must contain: + - The `fileKey` property. The value of this property is the key received when you uploaded the CSV file. + - The `price_list_id` property. The value of this property is the ID of the price list you’re importing the prices into. +- `dry_run`: This is optional to include. If not set or if its value is `false`, the price import will start right after you send this request. Settings its value to `true` allows you to retrieve afterward a brief of the number of prices that will be added. + +This request returns the batch job with its details such as the `status` or `id`. + +:::note + +If you don’t set `dry_run` or you set it to `false`, you don’t need to follow the rest of these steps. + +::: + +## (Optional) Retrieve Batch Job + +After creating the batch job, it will be pre-processed. At this point, the CSV file will be validated, and the number of prices to add are counted. + +You can retrieve all the details of the batch job, including its status and the brief statistics related to the prices by sending the following request: + + + + +```jsx +medusa.admin.batchJobs.retrieve(batchJobId) +.then(( batch_job ) => { + console.log(batch_job.status, batch_job.result); +}); +``` + + + + +```jsx +fetch(`/admin/batch-jobs/${batchJobId}`) +.then((response) => response.json()) +.then(({ batch_job }) => { + console.log(batch_job.status, batch_job.result); +}); +``` + + + + +```bash +curl --location --request GET '/admin/batch-jobs/' \ +--header 'Authorization: Bearer {api_token}' +# is the ID of the batch job +``` + + + + +This request accepts the batch job’s ID as a parameter, which can be retrieved from the previous request. It returns the batch job in the response. + +If the batch job has been pre-processed, the status of the batch job will be `pre_processed` and the `result` property will contain details about the import. + +Here’s an example of the `result` property: + +```json +"result": { + "count": 5, // Total number of prices to be added + "stat_descriptors": [ //details about the prices to be added + { + "key": "price-list-import-count", + "name": "PriceList to import", + "message": "5 prices will be added" + } + ], + "advancement_count": 0 //number of prices processed so far. Will be 0 before the import is confirmed. +}, +``` + +## 3. Confirm Batch Job + +A batch job can be confirmed only once the batch job has the status `pre_processed`. Once you confirm a batch job, the price import will start which will add prices to the price list + +To confirm a batch job send the following request: + + + + +```jsx +medusa.admin.batchJobs.confirm(batchJobId) +.then(( batch_job ) => { + console.log(batch_job.status); +}); +``` + + + + +```jsx +fetch(`/admin/batch-jobs/${batchJobId}/confirm`, { + method: 'POST' +}) +.then((response) => response.json()) +.then(({ batch_job }) => { + console.log(batch_job.status); +}); +``` + + + + +```bash +curl --location --request POST '/admin/batch-jobs//confirm' \ +--header 'Authorization: Bearer {api_token}' +# is the ID of the batch job +``` + + + + +This request accepts the ID of the batch job as a path parameter and returns the updated batch job. The returned batch job should have the status `confirmed`, which indicates that the batch job will now start processing. + +### Checking the Status After Confirmation + +After confirming the batch job, you can check the status while it is processing at any given point by retrieving the batch job. Based on the status, you can infer the progress of the batch job: + +- If the status is `processing`, it means that the import is currently in progress. You can also check `result.advancement_count` to find out how many prices have been added so far. +- If the status is `failed`, it means an error has occurred during the import. You can check the error in `result.errors`. +- If the status is `completed`, it means the import has finished successfully. + +## What’s Next 🚀 + +- Learn more about [Batch Jobs and how they work](../backend/batch-jobs/index.md). +- Check out the [Batch Jobs API Reference](https://docs.medusajs.com/api/admin/#tag/Batch-Job). \ No newline at end of file diff --git a/docs/content/advanced/backend/cron-jobs/create.md b/docs/content/advanced/backend/cron-jobs/create.md index a13f54163e..1b63c8ae28 100644 --- a/docs/content/advanced/backend/cron-jobs/create.md +++ b/docs/content/advanced/backend/cron-jobs/create.md @@ -20,17 +20,17 @@ Redis is required for cron jobs to work. Make sure you [install Redis](../../../ ## 1. Create a File -Each cron job should reside in a file under the `src/loaders` directory. +Each cron job should reside in a TypeScript or JavaScript file under the `src/loaders` directory. Start by creating the `src/loaders` directory. Then, inside that directory, create the JavaScript or TypeScript file that you’ll add the cron job in. You can use any name for the file. -For the example in this tutorial, you can create the file `src/loaders/publish.js`. +For the example in this tutorial, you can create the file `src/loaders/publish.ts`. ## 2. Create Cron Job -To create a cron job, add the following code in the file you created, which is `src/loaders/publish.js` in this example: +To create a cron job, add the following code in the file you created, which is `src/loaders/publish.ts` in this example: -```jsx +```ts const publishJob = async (container, options) => { const eventBus = container.resolve("eventBusService"); eventBus.createCronJob("publish-products", {}, "0 0 * * *", async () => { @@ -72,7 +72,7 @@ To pass data to your cron job, you can add them to the object passed as a second For example: -```jsx +```ts eventBus.createCronJob("publish-products", { data: { productId diff --git a/docs/content/advanced/backend/endpoints/add.md b/docs/content/advanced/backend/endpoints/add.md index 153484d796..9e78a59e95 100644 --- a/docs/content/advanced/backend/endpoints/add.md +++ b/docs/content/advanced/backend/endpoints/add.md @@ -4,13 +4,13 @@ In this document, you’ll learn how to create endpoints in your Medusa server. ## Overview -Custom endpoints reside under the `src/api` directory in your Medusa Backend. To define a new endpoint, you can add the file `index.js` under the `src/api` directory. This file should export a function that returns an Express router. +Custom endpoints reside under the `src/api` directory in your Medusa Backend. They're defined in a TypeScript or JavaScript file that is named `index` (for example, `index.ts`). This file should export a function that returns an Express router. ## Implementation -To create a new endpoint, start by creating a new file in `src/api` called `index.js`. At its basic format, `index.js` should look something like this: +To create a new endpoint, start by creating a new file in `src/api` called `index.ts`. At its basic format, `index.ts` should look something like this: -```jsx +```ts import { Router } from "express" export default (rootDirectory, pluginOptions) => { @@ -26,21 +26,21 @@ export default (rootDirectory, pluginOptions) => { } ``` -This exports a function that returns an Express router. The function receives two parameters: +This exports a function that returns an Express router. The function receives two parameters: - `rootDirectory` is the absolute path to the root directory that your server is running from. - `pluginOptions` is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object. ### Endpoints Path -Your endpoint can be under any path you wish. +Your endpoint can be under any path you wish. By Medusa’s conventions: - All Storefront REST APIs are prefixed by `/store`. For example, the `/store/products` endpoint lets you retrieve the products to display them on your storefront. - All Admin REST APIs are prefixed by `/admin`. For example, the `/admin/products` endpoint lets you retrieve the products to display them on your Admin. -You can also create endpoints that do not reside under these two prefixes, similar to the `hello` endpoint in the previous example. +You can also create endpoints that don't reside under these two prefixes, similar to the `hello` endpoint in the previous example. ## CORS Configuration @@ -48,14 +48,14 @@ If you’re adding a storefront or admin endpoint and you want to access these e First, you need to import your Medusa configurations along with the `cors` library: -```jsx +```ts import cors from "cors" import { projectConfig } from "../../medusa-config" ``` Then, create an object that will hold the Cross-Origin Resource Sharing (CORS) configurations. If it’s a storefront endpoint, pass the `origin` property storefront options: -```jsx +```ts const corsOptions = { origin: projectConfig.store_cors.split(","), credentials: true, @@ -64,7 +64,7 @@ const corsOptions = { If it’s an admin endpoint, pass the `origin` property admin options: -```jsx +```ts const corsOptions = { origin: projectConfig.admin_cors.split(","), credentials: true, @@ -73,7 +73,7 @@ const corsOptions = { Finally, for each route you add, create an `OPTIONS` request and add `cors` as a middleware for the route: -```jsx +```ts router.options("/admin/hello", cors(corsOptions)) router.get("/admin/hello", cors(corsOptions), (req, res) => { //... @@ -84,9 +84,9 @@ router.get("/admin/hello", cors(corsOptions), (req, res) => { ### Same File -You can add more than one endpoint in `src/api/index.js`: +You can add more than one endpoint in `src/api/index.ts`: -```jsx +```ts router.options("/store/hello", cors(storeCorsOptions)) router.get("/store/hello", cors(storeCorsOptions), (req, res) => { res.json({ @@ -106,11 +106,11 @@ router.get("/admin/hello", cors(adminCorsOptions), (req, res) => { Alternatively, you can add multiple files for each endpoint or set of endpoints for readability and easy maintenance. -To do that with the previous example, first, create the file `src/api/store.js` with the following content: +To do that with the previous example, first, create the file `src/api/store.ts` with the following content: -```jsx +```ts import cors from "cors" -import { projectConfig } from "../../../medusa-config" +import { projectConfig } from "../../medusa-config" export default (router) => { const storeCorsOptions = { @@ -128,11 +128,11 @@ export default (router) => { You export a function that receives an Express router as a parameter and adds the endpoint `store/hello` to it. -Next, create the file `src/api/admin.js` with the following content: +Next, create the file `src/api/admin.ts` with the following content: -```jsx +```ts import cors from "cors" -import { projectConfig } from "../../../medusa-config" +import { projectConfig } from "../../medusa-config" export default (router) => { const adminCorsOptions = { @@ -150,16 +150,16 @@ export default (router) => { Again, you export a function that receives an Express router as a parameter and adds the endpoint `admin/hello` to it. -Finally, in `src/api/index.js` import the two functions at the beginning of the file: +Finally, in `src/api/index.ts` import the two functions at the beginning of the file: -```jsx +```ts import storeRoutes from "./store" import adminRoutes from "./admin" ``` and in the exported function, call each of the functions passing them the Express router: -```jsx +```ts export default () => { const router = Router() @@ -178,13 +178,13 @@ Protected routes are routes that should be accessible by logged-in customers or To make a storefront route protected, first, import the `authenticate-customer` middleware: -```jsx +```ts import authenticate from "@medusajs/medusa/dist/api/middlewares/authenticate-customer" ``` Then, add the middleware to your route: -```jsx +```ts router.options("/store/hello", cors(corsOptions)) router.get("/store/hello", cors(corsOptions), authenticate(), async (req, res) => { if (req.user) { @@ -203,15 +203,15 @@ To disallow guest customers from accessing the endpoint, you can throw an error To make an admin route protected, first, import the `authenticate` middleware: -```jsx +```ts import authenticate from "@medusajs/medusa/dist/api/middlewares/authenticate" ``` Then, add the middleware to your route: -```jsx +```ts router.options("/admin/products/count", cors(corsOptions)) -router.get("/admin/products/count", cors(corsOptions), authenticate(), (req, res) => { +router.get("/admin/products/count", cors(corsOptions), authenticate(), async (req, res) => { //access current user const id = req.user.userId const userService = req.scope.resolve("userService") @@ -231,7 +231,7 @@ You can retrieve any registered service in your endpoint using `req.scope.resol Here’s an example of an endpoint that retrieves the count of products in your store: -```jsx +```ts router.get("/admin/products/count", cors(corsOptions), authenticate(), (req, res) => { const productService = req.scope.resolve("productService") diff --git a/docs/content/advanced/backend/migrations/index.md b/docs/content/advanced/backend/migrations/index.md index 0fb24f620f..f555afdbf5 100644 --- a/docs/content/advanced/backend/migrations/index.md +++ b/docs/content/advanced/backend/migrations/index.md @@ -16,10 +16,16 @@ The migration file must be inside the `src/migrations` directory. When you run t :::tip -You can learn more about writing migrations in [Typeorm’s Documentation](https://typeorm.io/migrations). +You can alternatively use Typeorm's `generate` command to generate a Migration file from existing database tables, which requires setting up a data source in Typeorm. Check out Typeorm's documentation to learn [how to create a data source](https://typeorm.io/data-source#creating-a-new-datasource), then use the [generate command](https://typeorm.io/using-cli#generate-a-migration-from-existing-table-schema). ::: +## Write Migration File + +The migration file contains the necessary commands to create the database columns, foreign keys, and more. + +You can learn more about writing the migration file in You can learn more about writing migrations in [Typeorm’s Documentation](https://typeorm.io/migrations). + ## Build Files Before you can run the migrations you need to run the build command to transpile the TypeScript files to JavaScript files: diff --git a/docs/content/advanced/backend/notification/how-to-create-notification-provider.md b/docs/content/advanced/backend/notification/how-to-create-notification-provider.md index ce52e64ec4..7f758885ed 100644 --- a/docs/content/advanced/backend/notification/how-to-create-notification-provider.md +++ b/docs/content/advanced/backend/notification/how-to-create-notification-provider.md @@ -1,43 +1,39 @@ # How to Create a Notification Provider -In this document, you’ll learn how to add a Notification Provider to your Medusa server. If you’re unfamiliar with the Notification architecture in Medusa, it is recommended to check out the [architecture overview](overview.md) first. +In this document, you’ll learn how to add a Notification Provider to your Medusa server. -## Overview +:::note -A Notification Provider is the custom or third-party service used to handle sending alerts to customers or users when an event occurs. - -For example, you can use SendGrid to send a confirmation email to a customer after they place an order. SendGrid in this example is a Notification Provider. - -:::tip - -If you’re interested in using SendGrid to send Notifications, you can use the [SendGrid](../../../add-plugins/sendgrid.mdx) plugin instead of using your own. +If you’re unfamiliar with the Notification architecture in Medusa, it is recommended to check out the [architecture overview](overview.md) first. ::: -Adding a Notification Provider is as simple as creating a [Service](../services/create-service.md) file in `src/services`. A Notification Provider is essentially a Service that extends the `NotificationService` from `medusa-interfaces`. - -:::info - -Notification Providers are loaded and installed at the server startup. - -::: - -After creating the Notification Provider Service, you must create a [Subscriber](../subscribers/create-subscriber.md) that subscribes the Notification Provider to specific events. - ## Prerequisites Before you start creating a Notification Provider, you need to install a [Medusa server](../../../quickstart/quick-start.md). -You also need to install and configure Redis. You can check out the documentation “[Set Up Your Development Environment](../../../tutorial/0-set-up-your-development-environment.mdx)” for help. +You also need to (../../../tutorial/0-set-up-your-development-environment.mdx#redis) and [configure it with the Medusa server](../../../usage/configurations.md#redis). ## Create a Notification Provider -The first step to creating a Notification Provider is to create a file in `src/services` with the following content: +Creating a Notification Provider is as simple as creating a TypeScript or JavaScript file in `src/services`. The name of the file is the name of the provider (for example, `sendgrid.ts`). A Notification Provider is essentially a Service that extends the `NotificationService` from `medusa-interfaces`. -```jsx -import { NotificationService } from "medusa-interfaces"; +For example, create the file `src/services/email-sender.ts` with the following content: -class EmailSenderService extends NotificationService { +```ts +import { AbstractNotificationService } from "@medusajs/medusa"; +import { EntityManager } from "typeorm"; + +class EmailSenderService extends AbstractNotificationService { + protected manager_: EntityManager; + protected transactionManager_: EntityManager; + + sendNotification(event: string, data: unknown, attachmentGenerator: unknown): Promise<{ to: string; status: string; data: Record; }> { + throw new Error("Method not implemented."); + } + resendNotification(notification: unknown, config: unknown, attachmentGenerator: unknown): Promise<{ to: string; status: string; data: Record; }> { + throw new Error("Method not implemented."); + } } @@ -64,7 +60,7 @@ The value of this property is also used later when you want to subscribe the Not For example, in the class you created in the previous code snippet you can add the following property: -```jsx +```ts static identifier = "email-sender"; ``` @@ -84,13 +80,26 @@ You can learn more about plugins and how to create them in the [Plugins](../plug Continuing on with the previous example, if you want to use the [`OrderService`](../../../references/services/classes/OrderService.md) later when sending notifications, you can inject it into the constructor: -```jsx -constructor({ orderService }, options) { - //you can access options here in case you're - //using a plugin - super(); +```ts +import { AbstractNotificationService, OrderService } from "@medusajs/medusa"; - this.orderService = orderService; +class EmailSenderService extends AbstractNotificationService { + protected manager_: EntityManager; + protected transactionManager_: EntityManager; + static identifier = "email-sender"; + protected orderService: OrderService; + + // highlight-start + constructor(container, options) { + super(container); + //you can access options here in case you're + //using a plugin + + this.orderService = container.orderService; + } + // highlight-end + + //... } ``` @@ -119,16 +128,17 @@ This method must return an object containing two properties: Continuing with the previous example you can have the following implementation of the `sendNotification` method: -```jsx -async sendNotification(eventName, eventData, attachmentGenerator) { - if (eventName === 'order.placed') { +```ts +async sendNotification(event: string, data: any, attachmentGenerator: unknown): Promise<{ to: string; status: string; data: Record; }> { + if (event === 'order.placed') { //retrieve order - const order = await this.orderService.retrieve(eventData.id); + const order = await this.orderService.retrieve(data.id); //TODO send email console.log('Notification sent'); return { to: order.email, + status: 'done', data: { //any data necessary to send the email //for example: @@ -169,16 +179,17 @@ Similarly to the `sendNotification` method, this method must return an object co Continuing with the previous example you can have the following implementation of the `resendNotification` method: -```jsx -resendNotification(notification, config, attachmentGenerator) { +```ts +async resendNotification(notification: any, config: any, attachmentGenerator: unknown): Promise<{ to: string; status: string; data: Record; }> { //check if the receiver of the notification should be changed - const to = config.to ? config.to : notification.to; + const to: string = config.to ? config.to : notification.to; //TODO resend the notification using the same data that is saved under notification.data console.log('Notification resent'); return { to, + status: 'done', data: notification.data //you can also make changes to the data } } @@ -208,7 +219,7 @@ This section will not cover the basics of Subscribers. You can read the [Subscri Following the previous example, to make sure the `email-sender` Notification Provider handles the `order.placed` event, create the file `src/subscribers/notification.js` with the following content: -```jsx +```ts class NotificationSubscriber { constructor({ notificationService }) { notificationService.subscribe('order.placed', 'email-sender'); @@ -232,7 +243,7 @@ Make sure you've configured Redis with your Medusa server as explained in the Pr Then, start by running your Medusa server: -```bash +```bash npm2yarn npm run start ``` diff --git a/docs/content/advanced/backend/notification/overview.md b/docs/content/advanced/backend/notification/overview.md index 0a4c6913cb..4183049aba 100644 --- a/docs/content/advanced/backend/notification/overview.md +++ b/docs/content/advanced/backend/notification/overview.md @@ -24,7 +24,7 @@ When you run your Medusa server, the Notification Provider is registered on your ### NotificationProvider Entity Overview -The [`NotificationProvider`](../../../references/js-client/classes/internal-11.NotificationProvider.md) entity only has 2 attributes: `id` and `is_installed`. +The `NotificationProvider` entity only has 2 attributes: `id` and `is_installed`. `id` is the value of the static property `identifier` defined inside the notification Service class. @@ -39,7 +39,7 @@ Notifications can take on other forms such as an SMS or a Slack message. ### How Notification is Created -Notifications are created in the `NotificationService` class in Medusa’s core after the Notification has been handled by the Notification Provider. +Notifications are created in the `NotificationService` class in Medusa’s core after the Notification has been handled by the Notification Provider. The data and additional details that the Notification Provider returns to the `NotificationService` is used to fill some of the attributes of the Notification in the database. @@ -47,7 +47,7 @@ A Notification also represents a resent notification. So, when a notification is ### Notification Entity Overview -The two most important properties in the [`Notification`](../../../references/js-client/classes/internal-11.Notification.md) entity are the `to` and `data` properties. +The two most important properties in the [`Notification`](../../../references/entities/classes/Notification.md) entity are the `to` and `data` properties. The `to` property is a string that represents the receiver of the Notification. For example, if the Notification was sent to an email address, the `to` property holds the email address the Notification was sent to. diff --git a/docs/content/advanced/backend/payment/how-to-create-payment-provider.md b/docs/content/advanced/backend/payment/how-to-create-payment-provider.md index 043cdc1f5d..59986d9098 100644 --- a/docs/content/advanced/backend/payment/how-to-create-payment-provider.md +++ b/docs/content/advanced/backend/payment/how-to-create-payment-provider.md @@ -10,7 +10,7 @@ By default, Medusa has a [manual payment provider](https://github.com/medusajs/m Adding a Payment Provider is as simple as creating a [service](../services/create-service.md) file in `src/services`. A Payment Provider is essentially a service that extends `AbstractPaymentService` from the core Medusa package `@medusajs/medusa`. -Payment Provider Services must have a static property `identifier`. It is the name that will be used to install and refer to the Payment Provider in the Medusa server. +Payment Provider Services must have a static property `identifier`. It's the name that will be used to install and refer to the Payment Provider in the Medusa server. :::tip @@ -44,12 +44,51 @@ These methods are used at different points in the Checkout flow as well as when ## Create a Payment Provider -The first step to create a payment provider is to create a file in `src/services` with the following content: +The first step to create a payment provider is to create a JavaScript or TypeScript file in `src/services`. The file's name should be the name of the payment provider. -```jsx -import { AbstractPaymentService } from "@medusajs/medusa" +For example, create the file `src/services/my-payment.ts` with the following content: -class MyPaymentService extends AbstractPaymentService { +```ts +import { AbstractPaymentService, Cart, Data, Payment, PaymentSession, PaymentSessionStatus, TransactionBaseService } from "@medusajs/medusa" +import { EntityManager } from "typeorm"; + +class MyPaymentService extends AbstractPaymentService { + protected manager_: EntityManager; + protected transactionManager_: EntityManager; + + getPaymentData(paymentSession: PaymentSession): Promise { + throw new Error("Method not implemented."); + } + updatePaymentData(paymentSessionData: Data, data: Data): Promise { + throw new Error("Method not implemented."); + } + createPayment(cart: Cart): Promise { + throw new Error("Method not implemented."); + } + retrievePayment(paymentData: Data): Promise { + throw new Error("Method not implemented."); + } + updatePayment(paymentSessionData: Data, cart: Cart): Promise { + throw new Error("Method not implemented."); + } + authorizePayment(paymentSession: PaymentSession, context: Data): Promise<{ data: Data; status: PaymentSessionStatus; }> { + throw new Error("Method not implemented."); + } + capturePayment(payment: Payment): Promise { + throw new Error("Method not implemented."); + } + refundPayment(payment: Payment, refundAmount: number): Promise { + throw new Error("Method not implemented."); + } + cancelPayment(payment: Payment): Promise { + throw new Error("Method not implemented."); + } + deletePayment(paymentSession: PaymentSession): Promise { + throw new Error("Method not implemented."); + } + getStatus(data: Data): Promise { + throw new Error("Method not implemented."); + } } @@ -82,8 +121,9 @@ You can also use the constructor to initialize your integration with the third-p Additionally, if you’re creating your Payment Provider as an external plugin to be installed on any Medusa server and you want to access the options added for the plugin, you can access it in the constructor. The options are passed as a second parameter: -```jsx -constructor({}, options) { +```ts +constructor({ productService }, options) { + super(); //you can access options here } ``` @@ -98,8 +138,11 @@ This method must return an object that is going to be stored in the `data` field An example of a minimal implementation of `createPayment` that does not interact with any third-party providers: -```jsx -async createPayment(cart) { +```ts +import { Cart, Data } from "@medusajs/medusa" +//... + +async createPayment(cart: Cart): Promise { return { id: 'test-payment', status: 'pending' @@ -117,8 +160,11 @@ This method must return an object containing the data from the third-party provi An example of a minimal implementation of `retrievePayment` where you don’t need to interact with the third-party provider: -```jsx -async retrievePayment(cart) { +```ts +import { Data } from "@medusajs/medusa" +//... + +async retrievePayment(paymentData: Data): Promise { return {}; } ``` @@ -141,9 +187,12 @@ This method returns a string that represents the status. The status must be one An example of a minimal implementation of `getStatus` where you don’t need to interact with the third-party provider: -```jsx -async getStatus (data) { - return data.status; +```ts +import { Data, PaymentSessionStatus } from "@medusajs/medusa" +//... + +async getStatus(data: Data): Promise { + return PaymentSessionStatus.AUTHORIZED; } ``` @@ -171,9 +220,12 @@ This method must return an object that will be stored in the `data` field of the An example of a minimal implementation of `updatePayment` that does not need to make any updates on the third-party provider or the `data` field of the Payment Session: -```jsx -async updatePayment(sessionData, cart) { - return sessionData; +```ts +import { Cart, Data } from "@medusajs/medusa"; +//... + +async updatePayment(paymentSessionData: Data, cart: Cart): Promise { + return paymentSessionData; } ``` @@ -189,8 +241,11 @@ This method must return an object that will be stored in the `data` field of the An example of a minimal implementation of `updatePaymentData` that returns the `updatedData` passed in the body of the request as-is to update the `data` field of the Payment Session. -```jsx -async updatePaymentData(sessionData, updatedData) { +```ts +import { Data } from "@medusajs/medusa"; +//... + +async updatePaymentData(paymentSessionData: Data, updatedData: Data): Promise { return updatedData; } ``` @@ -210,8 +265,11 @@ You can use this method to interact with the third-party provider to delete data An example of a minimal implementation of `deletePayment` where no interaction with a third-party provider is required: -```jsx -async deletePayment(paymentSession) { +```ts +import { PaymentSession } from "@medusajs/medusa"; +//... + +async deletePayment(paymentSession: PaymentSession): Promise { return; } ``` @@ -245,15 +303,18 @@ You can utilize this method to interact with the third-party provider and perfor An example of a minimal implementation of `authorizePayment` that doesn’t need to interact with any third-party provider: -```jsx -async authorizePayment(paymentSession, context) { - return { - status: 'authorized', - data: { - id: 'test' - } - }; - } +```ts +import { Data, PaymentSession, PaymentSessionStatus } from "@medusajs/medusa"; +//... + +async authorizePayment(paymentSession: PaymentSession, context: Data): Promise<{ data: Data; status: PaymentSessionStatus; }> { + return { + status: PaymentSessionStatus.AUTHORIZED, + data: { + id: 'test' + } + }; +} ``` ### getPaymentData @@ -266,8 +327,11 @@ This method must return an object to be stored in the `data` field of the Paymen An example of a minimal implementation of `getPaymentData`: -```jsx -async getPaymentData(paymentSession) { +```ts +import { Data, PaymentSession } from "@medusajs/medusa"; +//... + +async getPaymentData(paymentSession: PaymentSession): Promise { return paymentSession.data; } ``` @@ -286,8 +350,11 @@ This method must return an object that will be stored in the `data` field of the An example of a minimal implementation of `capturePayment` that doesn’t need to interact with a third-party provider: -```jsx -async capturePayment(payment) { +```ts +import { Data, Payment } from "@medusajs/medusa"; +//... + +async capturePayment(payment: Payment): Promise { return { status: 'captured' }; @@ -308,8 +375,11 @@ This method must return an object that is stored in the `data` field of the Paym An example of a minimal implementation of `refundPayment` that doesn’t need to interact with a third-party provider: -```jsx -async refundPayment(payment, amount) { +```ts +import { Data, Payment } from "@medusajs/medusa"; +//... + +async refundPayment(payment: Payment, refundAmount: number): Promise { return { id: 'test' } @@ -333,8 +403,11 @@ This method must return an object that is stored in the `data` field of the Paym An example of a minimal implementation of `cancelPayment` that doesn’t need to interact with a third-party provider: -```jsx -async cancelPayment(payment) { +```ts +import { Data, Payment } from "@medusajs/medusa"; +//... + +async cancelPayment(payment: Payment): Promise { return { id: 'test' } @@ -361,13 +434,16 @@ If you’re using Medusa’s [Next.js](../../../starters/nextjs-medusa-starter.m An example of the implementation of `retrieveSavedMethods` taken from Stripe’s Payment Provider: -```jsx +```ts +import { Customer, Data } from "@medusajs/medusa" +//... + /** * Fetches a customers saved payment methods if registered in Stripe. * @param {object} customer - customer to fetch saved cards for * @returns {Promise>} saved payments methods */ -async retrieveSavedMethods(customer) { +async retrieveSavedMethods(customer: Customer): Promise { if (customer.metadata && customer.metadata.stripe_id) { const methods = await this.stripe_.paymentMethods.list({ customer: customer.metadata.stripe_id, diff --git a/docs/content/advanced/backend/services/create-service.md b/docs/content/advanced/backend/services/create-service.md index 1d6b57128a..67add52018 100644 --- a/docs/content/advanced/backend/services/create-service.md +++ b/docs/content/advanced/backend/services/create-service.md @@ -4,14 +4,16 @@ In this document, you’ll learn how you can create a [Service](./overview.md) a ## Implementation -To create a service, you should create a JavaScript file in `src/services` to hold the service. The name of the file should be the registration name of the service without `Service` as it will be appended to it by default. +To create a service, create a TypeScript or JavaScript file in `src/services` to hold the service. The name of the file should be the registration name of the service without `Service` as it will be appended to it by default. -For example, if you want to create a service `helloService`, create the file `hello.js` in `src/services` with the following content: +For example, if you want to create a service `helloService`, create the file `hello.ts` in `src/services` with the following content: -```js +```ts import { TransactionBaseService } from '@medusajs/medusa'; class HelloService extends TransactionBaseService { + protected manager_: EntityManager; + protected transactionManager_: EntityManager; getMessage() { return `Welcome to My Store!` } @@ -26,18 +28,18 @@ As the service extends the `TransactionBaseService` class, all services in Medus So, if you want your service to use another service, simply add it as part of your constructor’s dependencies and set it to a field inside your service’s class: -```js -productService; +```ts +private productService: ProductService; -constructor({ productService }) { - super(); - this.productService = productService; +constructor(container) { + super(container); + this.productService = container.productService; } ``` Then, you can use that service anywhere in your custom service: -```js +```ts async getProductCount() { return await this.productService.count(); } @@ -61,10 +63,10 @@ npm run build To use your custom service in another custom service, you can have easy access to it in the dependencies injected to the constructor of your service: -```js -constructor({ helloService }) { - super(); - this.helloService = helloService; +```ts +constructor(container) { + super(container); + this.helloService = container.helloService; } ``` @@ -72,7 +74,7 @@ constructor({ helloService }) { To use your custom service in an endpoint, you can use `req.scope.resolve` passing it the service’s registration name: -```js +```ts const helloService = req.scope.resolve("helloService") res.json({ @@ -84,7 +86,7 @@ res.json({ To use your custom service in a subscriber, you can have easy access to it in the subscriber’s dependencies injected to the constructor of your subscriber: -```js +```ts constructor({ helloService, eventBusService }) { this.helloService = helloService; } diff --git a/docs/content/advanced/backend/shipping/add-fulfillment-provider.md b/docs/content/advanced/backend/shipping/add-fulfillment-provider.md index f2c04f1807..999e5f7006 100644 --- a/docs/content/advanced/backend/shipping/add-fulfillment-provider.md +++ b/docs/content/advanced/backend/shipping/add-fulfillment-provider.md @@ -21,9 +21,9 @@ Fulfillment providers are loaded and installed on the server startup. ## Create a Fulfillment Provider -The first step is to create the file that will hold the fulfillment provider class in `src/services`: +The first step is to create a JavaScript or TypeScript file under `src/services`. For example, create the file `src/services/my-fulfillment.ts` with the following content: -```jsx +```ts import { FulfillmentService } from "medusa-interfaces" class MyFulfillmentService extends FulfillmentService { @@ -33,7 +33,7 @@ class MyFulfillmentService extends FulfillmentService { export default MyFulfillmentService; ``` -Fulfillment provider services should extend `FulfillmentService` imported from `medusa-interfaces`. +Fulfillment provider services must extend the `FulfillmentService` class imported from `medusa-interfaces`. :::note @@ -49,7 +49,7 @@ The `FulfillmentProvider` entity has 2 properties: `identifier` and `is_installe The value of this property will also be used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin/#tag/Region/operation/PostRegionsRegionFulfillmentProviders) to a region. -```jsx +```ts import { FulfillmentService } from "medusa-interfaces" class MyFulfillmentService extends FulfillmentService { @@ -61,14 +61,17 @@ export default MyFulfillmentService; ### constructor -You can use the `constructor` of your fulfillment provider to have access to different services in Medusa through dependency injection. +You can use the `constructor` of your fulfillment provider to have access to different services in Medusa through dependency injection. You can access any services you create in Medusa in the first parameter. You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service. -Additionally, if you’re creating your fulfillment provider as an external plugin to be installed on any Medusa server and you want to access the options added for the plugin, you can access it in the constructor. The options are passed as a second parameter: +Additionally, if you’re creating your fulfillment provider as an external plugin to be installed on any Medusa server and you want to access the options added for the plugin, you can access it in the constructor. The options are passed as a second parameter. -```jsx -constructor({}, options) { +For example: + +```ts +constructor({ productService }, options) { + super(); //you can access options here } ``` @@ -83,22 +86,22 @@ These fulfillment options are defined in the `getFulfillmentOptions` method. Thi For example: -```jsx +```ts async getFulfillmentOptions () { - return [ - { - id: 'my-fulfillment' - }, - { - id: 'my-fulfillment-dynamic' - } - ]; - } + return [ + { + id: 'my-fulfillment' + }, + { + id: 'my-fulfillment-dynamic' + } + ]; +} ``` When the admin chooses one of those fulfillment options, the data of the chosen fulfillment option is stored in the `data` property of the shipping option created. This property is used to add any additional data you need to fulfill the order with the third-party provider. -For that reason, the fulfillment option does not have any required structure and can be of any format that works for your integration. +For that reason, the fulfillment option doesn't have any required structure and can be of any format that works for your integration. ### validateOption @@ -110,7 +113,7 @@ This method returns a boolean. If the result is false, an error is thrown and th For example, you can use this method to ensure that the `id` in the `data` object is correct: -```jsx +```ts async validateOption (data) { return data.id == 'my-fulfillment'; } @@ -138,7 +141,7 @@ If everything is valid, this method must return a value that will be stored in t For example: -```jsx +```ts async validateFulfillmentData(optionData, data, cart) { if (data.id !== "my-fulfillment") { throw new Error("invalid data"); @@ -167,7 +170,7 @@ You can use the `data` property in the shipping method (first parameter) to acce Here is a basic implementation of `createFulfillment` for a fulfillment provider that does not interact with any third-party provider to create the fulfillment: -```jsx +```ts createFulfillment( methodData, fulfillmentItems, @@ -200,7 +203,7 @@ This method receives as a parameter the `data` object sent with the request that For example: -```jsx +```ts canCalculate(data) { return data.id === 'my-fulfillment-dynamic'; } @@ -218,7 +221,7 @@ This method receives three parameters: If your fulfillment provider does not provide any dynamically calculated rates you can keep the function empty: -```jsx +```ts calculatePrice() { } @@ -226,7 +229,7 @@ calculatePrice() { Otherwise, you can use it to calculate the price with a custom logic. For example: -```jsx +```ts calculatePrice (optionData, data, cart) { return cart.items.length * 1000; } @@ -244,7 +247,7 @@ It receives the return created as a parameter. The value it returns is set to th This is the basic implementation of the method for a fulfillment provider that does not contact with a third-party provider to fulfill the return: -```jsx +```ts createReturn(returnOrder) { return Promise.resolve({}) } @@ -260,7 +263,7 @@ This method receives the fulfillment being cancelled as a parameter. This is the basic implementation of the method for a fulfillment provider that does not interact with a third-party provider to cancel the fulfillment: -```jsx +```ts cancelFulfillment(fulfillment) { return Promise.resolve({}) } diff --git a/docs/content/advanced/backend/subscribers/create-subscriber.md b/docs/content/advanced/backend/subscribers/create-subscriber.md index 6005a39206..9f091c1199 100644 --- a/docs/content/advanced/backend/subscribers/create-subscriber.md +++ b/docs/content/advanced/backend/subscribers/create-subscriber.md @@ -4,36 +4,21 @@ In this document, you’ll learn how to create a [Subscriber](overview.md) in yo ## Prerequisites -Medusa's event system works by pushing data to a Queue that each handler then gets notified of. The queuing system is based on Redis and you will therefore need to make sure that [Redis](https://redis.io) is installed and configured for your Medusa project. +Medusa's event system works by pushing data to a Queue that each handler then gets notified of. The queuing system is based on Redis, so it's required for subscribers to work. -Then, you need to set your Redis URL in your Medusa server. By default, the Redis URL is `redis://localhost:6379`. If you use a different one, set the following environment variable in `.env`: - -```bash -REDIS_URL= -``` - -After that, in `medusa-config.js`, you’ll need to comment out the following line: - -```jsx -module.exports = { - projectConfig: { - redis_url: REDIS_URL, //this line is commented out - ... - } -} -``` - -After that, you are able to listen to events on your server. +You can learn how to [install Redis](../../../tutorial/0-set-up-your-development-environment.mdx#redis) and [configure it with Medusa](../../../usage/configurations.md#redis) before you get started. ## Implementation -After creating the file under `src/subscribers`, in the constructor of your subscriber, you should listen to events using `eventBusService.subscribe` , where `eventBusService` is a service injected into your subscriber’s constructor. +A subscriber is a TypeScript or JavaScript file that is created under `src/subscribers`. Its file name, by convension, should be the class name of the subscriber without the word `Subscriber`. For example, if the subscriber is `HelloSubscriber`, the file name should be `hello.ts`. + +After creating the file under `src/subscribers`, in the constructor of your subscriber, listen to events using `eventBusService.subscribe` , where `eventBusService` is a service injected into your subscriber’s constructor. The `eventBusService.subscribe` method receives the name of the event as a first parameter and as a second parameter a method in your subscriber that will handle this event. For example, here is the `OrderNotifierSubscriber` class which is created in `src/subscribers/orderNotifier.js`: -```jsx +```ts class OrderNotifierSubscriber { constructor({ eventBusService }) { eventBusService.subscribe("order.placed", this.handleOrder); @@ -47,21 +32,21 @@ class OrderNotifierSubscriber { export default OrderNotifierSubscriber; ``` -This subscriber will register the method `handleOrder` as one of the handlers of the `order.placed` event. The method `handleOrder` will be executed every time an order is placed, and it will receive the order ID in the `data` parameter. You can then use the order’s details to perform any kind of task you need. +This subscriber registers the method `handleOrder` as one of the handlers of the `order.placed` event. The method `handleOrder` will be executed every time an order is placed. It receives the order ID in the `data` parameter. You can then use the order’s details to perform any kind of task you need. :::note -The `data` object will not contain other order data. Only the ID of the order. You can retrieve the order information using the `orderService`. +The `data` object won't contain other order data. Only the ID of the order. You can retrieve the order information using the `orderService`. ::: ## Using Services in Subscribers -You can access any service through the dependencies injected to your subscriber’s constructor. +You can access any service through the dependencies injected to your subscriber’s constructor. For example: -```jsx +```ts constructor({ productService, eventBusService }) { this.productService = productService; diff --git a/docs/content/advanced/storefront/use-sales-channels.mdx b/docs/content/advanced/storefront/use-sales-channels.mdx new file mode 100644 index 0000000000..f4511eb7d3 --- /dev/null +++ b/docs/content/advanced/storefront/use-sales-channels.mdx @@ -0,0 +1,148 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# How to Use Sales Channels in Storefronts + +In this document, you’ll learn how to use sales channels in your storefront. + +## Overview + +In your storefront, you can filter products by sales channels. You can also associate carts with a sales channel. + +This guide explains how to perform these operations using the Storefront APIs. + +## Prerequisites + +### Medusa Components + +It's assumed that you already have a Medusa server installed and set up. If not, you can follow our [quickstart guide](../../quickstart/quick-start.md) to get started. + +It is also assumed you already have a storefront set up. It can be a custom storefront or one of Medusa’s storefronts. If you don’t have a storefront set up, you can install either the [Next.js](../../starters/nextjs-medusa-starter.md) or [Gatsby](../../starters/gatsby-medusa-starter.md) storefronts. + +### JS Client + +This guide includes code snippets to send requests to your Medusa server using Medusa’s JS Client and JavaScript’s Fetch API. + +If you follow the JS Client code blocks, it’s assumed you already have [Medusa’s JS Client installed](../../js-client/overview.md) and have [created an instance of the client](../../js-client/overview.md#configuration). + +## Filter Products by Sales Channel + +To filter products by a specific sales channel, pass the `sales_channel_id` query parameter to the List Products endpoint: + + + + +```jsx +medusa.products.list({ + sales_channel_id: [ + salesChannelId + ] +}) +.then(({ products, limit, offset, count }) => { + console.log(products.length); +}); +``` + + + + +```jsx +fetch(`/store/products?sales_channel_id[0]=${salesChannelId}`) +.then((response) => response.json()) +.then(({ products, limit, offset, count }) => { + console.log(products.length) +}); +``` + + + + +The `sales_channel_id` query parameter is an array of sales channel IDs. You can pass more than one sales channel. + +The request returns an array of products. These are the products that are available in the sales channel. + +## Associate a Cart with a Sales Channel + +### When Creating a Cart + +To associate a sales channel with a cart while creating it, you can pass the `sales_channel_id` request body parameter with the ID of the sales channel: + + + + + +```jsx +medusa.carts.create({ + sales_channel_id: salesChannelId +}) +.then(({cart}) => { + console.log(cart.id); +}); +``` + + + + +```jsx +fetch(`/store/carts`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + sales_channel_id: salesChannelId + }) +}) +.then((response) => response.json()) +.then(({cart}) => { + console.log(cart.id); +}); +``` + + + + +The request returns the created cart. + +### Updating an Existing Cart + +You can update the sales channel of an existing cart by passing the `sales_channel_id` request body parameter with the ID of the sales channel: + + + + +```jsx +medusa.carts.update(cartId, { + sales_channel_id: salesChannelId +}) +.then(({cart}) => { + console.log(cart.id); +}); +``` + + + + +```jsx +fetch(`/store/carts/${cartId}`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify({ + sales_channel_id: salesChannelId + }) +}) +.then((response) => response.json()) +.then(({cart}) => console.log(cart.id)); +``` + + + + +The request returns the updated cart. + +## What’s Next 🚀 + +- Learn how to [Implement the Cart functionality in a storefront](../../guides/carts-in-medusa.mdx). +- Learn how to [Implement the Checkout functionality in a storefront](./how-to-implement-checkout-flow.mdx). \ No newline at end of file diff --git a/docs/content/references/entities/classes/Address.md b/docs/content/references/entities/classes/Address.md index 4de780818e..51f57ed924 100644 --- a/docs/content/references/entities/classes/Address.md +++ b/docs/content/references/entities/classes/Address.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/address.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L120) +[models/address.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L36) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/address.ts:123](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L123) +[models/address.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L39) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/address.ts:126](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L126) +[models/address.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L42) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/address.ts:111](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L111) +[models/address.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L27) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/address.ts:133](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L133) +[models/address.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L49) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/address.ts:129](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L129) +[models/address.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L45) ___ @@ -92,7 +92,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/address.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L108) +[models/address.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L24) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/address.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L104) +[models/address.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L20) ___ @@ -126,7 +126,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/address.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L114) +[models/address.ts:30](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L30) ___ @@ -150,7 +150,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/address.ts:117](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L117) +[models/address.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L33) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/address.ts:145](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L145) +[models/address.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L61) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/address.ts:142](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L142) +[models/address.ts:58](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L58) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/address.ts:139](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L139) +[models/address.ts:55](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L55) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/address.ts:136](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L136) +[models/address.ts:52](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L52) ___ @@ -214,7 +214,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -228,4 +228,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/address.ts:147](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L147) +[models/address.ts:63](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/address.ts#L63) diff --git a/docs/content/references/entities/classes/BatchJob.md b/docs/content/references/entities/classes/BatchJob.md index 5b93a368a0..0773b990d5 100644 --- a/docs/content/references/entities/classes/BatchJob.md +++ b/docs/content/references/entities/classes/BatchJob.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L62) +[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L62) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L59) +[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L59) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L56) +[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L56) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L33) +[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L33) ___ @@ -72,7 +72,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L26) +[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L26) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L30) +[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L30) ___ @@ -106,7 +106,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L47) +[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L47) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L65) +[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L65) ___ @@ -140,7 +140,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L50) +[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L50) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L53) +[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L53) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L36) +[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L36) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L67) +[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L67) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L23) +[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L23) ___ @@ -204,7 +204,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -218,7 +218,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L94) +[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L94) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L69) +[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L69) ___ @@ -246,4 +246,4 @@ ___ #### Defined in -[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L99) +[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/batch-job.ts#L99) diff --git a/docs/content/references/entities/classes/Cart.md b/docs/content/references/entities/classes/Cart.md index 9bdde7d624..598c025e4b 100644 --- a/docs/content/references/entities/classes/Cart.md +++ b/docs/content/references/entities/classes/Cart.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/cart.ts:226](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L226) +[models/cart.ts:226](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L226) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/cart.ts:220](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L220) +[models/cart.ts:220](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L220) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/cart.ts:311](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L311) +[models/cart.ts:311](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L311) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/cart.ts:320](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L320) +[models/cart.ts:320](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L320) ___ @@ -72,7 +72,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/cart.ts:285](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L285) +[models/cart.ts:285](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L285) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[models/cart.ts:281](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L281) +[models/cart.ts:281](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L281) ___ @@ -106,7 +106,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/cart.ts:335](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L335) +[models/cart.ts:335](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L335) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/cart.ts:263](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L263) +[models/cart.ts:263](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L263) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/cart.ts:216](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L216) +[models/cart.ts:216](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L216) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/cart.ts:342](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L342) +[models/cart.ts:344](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L344) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/cart.ts:341](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L341) +[models/cart.ts:343](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L343) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/cart.ts:277](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L277) +[models/cart.ts:277](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L277) ___ @@ -180,7 +180,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -190,7 +190,17 @@ ___ #### Defined in -[models/cart.ts:317](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L317) +[models/cart.ts:317](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L317) + +___ + +### item\_tax\_total + +• `Optional` **item\_tax\_total**: ``null`` \| `number` + +#### Defined in + +[models/cart.ts:336](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L336) ___ @@ -200,7 +210,7 @@ ___ #### Defined in -[models/cart.ts:241](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L241) +[models/cart.ts:241](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L241) ___ @@ -210,7 +220,7 @@ ___ #### Defined in -[models/cart.ts:323](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L323) +[models/cart.ts:323](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L323) ___ @@ -220,7 +230,7 @@ ___ #### Defined in -[models/cart.ts:213](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L213) +[models/cart.ts:213](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L213) ___ @@ -230,7 +240,7 @@ ___ #### Defined in -[models/cart.ts:300](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L300) +[models/cart.ts:300](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L300) ___ @@ -240,7 +250,7 @@ ___ #### Defined in -[models/cart.ts:314](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L314) +[models/cart.ts:314](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L314) ___ @@ -250,7 +260,7 @@ ___ #### Defined in -[models/cart.ts:296](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L296) +[models/cart.ts:296](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L296) ___ @@ -260,7 +270,7 @@ ___ #### Defined in -[models/cart.ts:287](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L287) +[models/cart.ts:287](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L287) ___ @@ -270,7 +280,7 @@ ___ #### Defined in -[models/cart.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L292) +[models/cart.ts:292](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L292) ___ @@ -280,7 +290,7 @@ ___ #### Defined in -[models/cart.ts:340](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L340) +[models/cart.ts:342](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L342) ___ @@ -290,7 +300,7 @@ ___ #### Defined in -[models/cart.ts:337](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L337) +[models/cart.ts:339](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L339) ___ @@ -300,7 +310,7 @@ ___ #### Defined in -[models/cart.ts:249](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L249) +[models/cart.ts:249](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L249) ___ @@ -310,7 +320,7 @@ ___ #### Defined in -[models/cart.ts:245](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L245) +[models/cart.ts:245](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L245) ___ @@ -320,7 +330,7 @@ ___ #### Defined in -[models/cart.ts:332](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L332) +[models/cart.ts:332](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L332) ___ @@ -330,7 +340,7 @@ ___ #### Defined in -[models/cart.ts:326](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L326) +[models/cart.ts:326](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L326) ___ @@ -340,7 +350,7 @@ ___ #### Defined in -[models/cart.ts:236](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L236) +[models/cart.ts:236](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L236) ___ @@ -350,7 +360,7 @@ ___ #### Defined in -[models/cart.ts:230](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L230) +[models/cart.ts:230](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L230) ___ @@ -360,7 +370,17 @@ ___ #### Defined in -[models/cart.ts:305](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L305) +[models/cart.ts:305](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L305) + +___ + +### shipping\_tax\_total + +• `Optional` **shipping\_tax\_total**: ``null`` \| `number` + +#### Defined in + +[models/cart.ts:337](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L337) ___ @@ -370,7 +390,7 @@ ___ #### Defined in -[models/cart.ts:334](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L334) +[models/cart.ts:334](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L334) ___ @@ -380,7 +400,7 @@ ___ #### Defined in -[models/cart.ts:339](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L339) +[models/cart.ts:341](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L341) ___ @@ -390,7 +410,7 @@ ___ #### Defined in -[models/cart.ts:336](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L336) +[models/cart.ts:338](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L338) ___ @@ -400,7 +420,7 @@ ___ #### Defined in -[models/cart.ts:338](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L338) +[models/cart.ts:340](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L340) ___ @@ -410,7 +430,7 @@ ___ #### Defined in -[models/cart.ts:308](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L308) +[models/cart.ts:308](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L308) ___ @@ -424,7 +444,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -438,7 +458,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/cart.ts:344](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L344) +[models/cart.ts:346](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L346) ___ @@ -452,4 +472,4 @@ ___ #### Defined in -[models/cart.ts:351](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L351) +[models/cart.ts:353](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L353) diff --git a/docs/content/references/entities/classes/ClaimImage.md b/docs/content/references/entities/classes/ClaimImage.md index cf6e69aa20..aefb4b76d4 100644 --- a/docs/content/references/entities/classes/ClaimImage.md +++ b/docs/content/references/entities/classes/ClaimImage.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L23) +[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-image.ts#L23) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L19) +[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-image.ts#L19) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L29) +[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-image.ts#L29) ___ @@ -104,7 +104,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L26) +[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-image.ts#L26) ## Methods @@ -128,4 +128,4 @@ ___ #### Defined in -[models/claim-image.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L31) +[models/claim-image.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-image.ts#L31) diff --git a/docs/content/references/entities/classes/ClaimItem.md b/docs/content/references/entities/classes/ClaimItem.md index d137edf741..6f77bd1e34 100644 --- a/docs/content/references/entities/classes/ClaimItem.md +++ b/docs/content/references/entities/classes/ClaimItem.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L42) +[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L42) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L38) +[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L38) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L34) +[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L34) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L50) +[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L50) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L46) +[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L46) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L84) +[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L84) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L64) +[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L64) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L67) +[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L67) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L61) +[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L61) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L81) +[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L81) ___ @@ -174,7 +174,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L58) +[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L58) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L54) +[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L54) ## Methods @@ -208,4 +208,4 @@ ___ #### Defined in -[models/claim-item.ts:86](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L86) +[models/claim-item.ts:86](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L86) diff --git a/docs/content/references/entities/classes/ClaimOrder.md b/docs/content/references/entities/classes/ClaimOrder.md index fc0cb37039..bc9c865ee7 100644 --- a/docs/content/references/entities/classes/ClaimOrder.md +++ b/docs/content/references/entities/classes/ClaimOrder.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L69) +[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L69) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L107) +[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L107) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L66) +[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L66) ___ @@ -62,7 +62,7 @@ SoftDeletableEntity.created\_at #### Defined in -[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L110) +[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L110) ___ @@ -76,7 +76,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L116) +[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L116) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L63) +[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L63) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L101) +[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L101) ___ @@ -110,7 +110,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L125) +[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L125) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L122) +[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L122) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L119) +[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L119) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L80) +[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L80) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L76) +[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L76) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L56) +[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L56) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L104) +[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L104) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L83) +[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L83) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L91) +[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L91) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L87) +[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L87) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L96) +[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L96) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L72) +[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L72) ___ @@ -244,7 +244,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L113) +[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L113) ## Methods @@ -258,4 +258,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/claim-order.ts:127](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L127) +[models/claim-order.ts:127](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L127) diff --git a/docs/content/references/entities/classes/ClaimTag.md b/docs/content/references/entities/classes/ClaimTag.md index d87ea1f152..d5e2ca776a 100644 --- a/docs/content/references/entities/classes/ClaimTag.md +++ b/docs/content/references/entities/classes/ClaimTag.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-tag.ts#L14) +[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-tag.ts#L14) ___ @@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-tag.ts#L11) +[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-tag.ts#L11) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[models/claim-tag.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-tag.ts#L16) +[models/claim-tag.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-tag.ts#L16) diff --git a/docs/content/references/entities/classes/Country.md b/docs/content/references/entities/classes/Country.md index cf7ad1b243..1f2fe63acc 100644 --- a/docs/content/references/entities/classes/Country.md +++ b/docs/content/references/entities/classes/Country.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/country.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L31) +[models/country.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/country.ts#L31) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/country.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L15) +[models/country.ts:15](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/country.ts#L15) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/country.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L19) +[models/country.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/country.ts#L19) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/country.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L22) +[models/country.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/country.ts#L22) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/country.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L28) +[models/country.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/country.ts#L28) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/country.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L25) +[models/country.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/country.ts#L25) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/country.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L39) +[models/country.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/country.ts#L39) ___ @@ -88,4 +88,4 @@ ___ #### Defined in -[models/country.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L35) +[models/country.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/country.ts#L35) diff --git a/docs/content/references/entities/classes/Currency.md b/docs/content/references/entities/classes/Currency.md index d994c8ce9d..636cb45ea4 100644 --- a/docs/content/references/entities/classes/Currency.md +++ b/docs/content/references/entities/classes/Currency.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/currency.ts:8](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L8) +[models/currency.ts:8](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/currency.ts#L8) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/currency.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L20) +[models/currency.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/currency.ts#L20) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/currency.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L17) +[models/currency.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/currency.ts#L17) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/currency.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L11) +[models/currency.ts:11](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/currency.ts#L11) ___ @@ -58,4 +58,4 @@ ___ #### Defined in -[models/currency.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L14) +[models/currency.ts:14](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/currency.ts#L14) diff --git a/docs/content/references/entities/classes/CustomShippingOption.md b/docs/content/references/entities/classes/CustomShippingOption.md index b4d67a9495..2ff8ca1577 100644 --- a/docs/content/references/entities/classes/CustomShippingOption.md +++ b/docs/content/references/entities/classes/CustomShippingOption.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L37) +[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/custom-shipping-option.ts#L37) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L33) +[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/custom-shipping-option.ts#L33) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L40) +[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/custom-shipping-option.ts#L40) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L21) +[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/custom-shipping-option.ts#L21) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L29) +[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/custom-shipping-option.ts#L29) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L25) +[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/custom-shipping-option.ts#L25) ___ @@ -134,7 +134,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -148,4 +148,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L42) +[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/custom-shipping-option.ts#L42) diff --git a/docs/content/references/entities/classes/Customer.md b/docs/content/references/entities/classes/Customer.md index 663b6294a1..1617b68049 100644 --- a/docs/content/references/entities/classes/Customer.md +++ b/docs/content/references/entities/classes/Customer.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/customer.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L38) +[models/customer.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L38) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/customer.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L34) +[models/customer.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L34) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/customer.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L24) +[models/customer.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L24) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/customer.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L27) +[models/customer.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L27) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/customer.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L69) +[models/customer.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L69) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/customer.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L50) +[models/customer.ts:50](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L50) ___ @@ -120,7 +120,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/customer.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L30) +[models/customer.ts:30](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L30) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/customer.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L72) +[models/customer.ts:72](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L72) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/customer.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L53) +[models/customer.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L53) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/customer.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L44) +[models/customer.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L44) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/customer.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L47) +[models/customer.ts:47](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L47) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/customer.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L41) +[models/customer.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L41) ___ @@ -194,7 +194,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -208,4 +208,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/customer.ts:74](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L74) +[models/customer.ts:74](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer.ts#L74) diff --git a/docs/content/references/entities/classes/CustomerGroup.md b/docs/content/references/entities/classes/CustomerGroup.md index e29b7c5783..6a1d0483dc 100644 --- a/docs/content/references/entities/classes/CustomerGroup.md +++ b/docs/content/references/entities/classes/CustomerGroup.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L18) +[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer-group.ts#L18) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -70,7 +70,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L26) +[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer-group.ts#L26) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L13) +[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer-group.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L23) +[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer-group.ts#L23) ___ @@ -114,7 +114,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -128,4 +128,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/customer-group.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L28) +[models/customer-group.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/customer-group.ts#L28) diff --git a/docs/content/references/entities/classes/Discount.md b/docs/content/references/entities/classes/Discount.md index 411c92cb7a..53de0ce654 100644 --- a/docs/content/references/entities/classes/Discount.md +++ b/docs/content/references/entities/classes/Discount.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/discount.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L22) +[models/discount.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L22) ___ @@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/discount.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L52) +[models/discount.ts:52](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L52) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/discount.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L36) +[models/discount.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L36) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/discount.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L25) +[models/discount.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L25) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/discount.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L78) +[models/discount.ts:78](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L78) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/discount.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L43) +[models/discount.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L43) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/discount.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L39) +[models/discount.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L39) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/discount.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L69) +[models/discount.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L69) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/discount.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L33) +[models/discount.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L33) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/discount.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L29) +[models/discount.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L29) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/discount.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L49) +[models/discount.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L49) ___ @@ -184,7 +184,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[models/discount.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L75) +[models/discount.ts:75](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L75) ___ @@ -204,7 +204,7 @@ ___ #### Defined in -[models/discount.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L72) +[models/discount.ts:72](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L72) ___ @@ -214,13 +214,13 @@ ___ #### Defined in -[models/discount.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L55) +[models/discount.ts:55](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L55) ## Methods -### upperCaseCode +### upperCaseCodeAndTrim -▸ `Private` **upperCaseCode**(): `void` +▸ `Private` **upperCaseCodeAndTrim**(): `void` #### Returns @@ -228,4 +228,4 @@ ___ #### Defined in -[models/discount.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L80) +[models/discount.ts:80](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount.ts#L80) diff --git a/docs/content/references/entities/classes/DiscountCondition.md b/docs/content/references/entities/classes/DiscountCondition.md index dd48cb31fc..60b899b5a6 100644 --- a/docs/content/references/entities/classes/DiscountCondition.md +++ b/docs/content/references/entities/classes/DiscountCondition.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/discount-condition.ts:127](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L127) +[models/discount-condition.ts:127](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L127) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/discount-condition.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L57) +[models/discount-condition.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L57) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/discount-condition.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L53) +[models/discount-condition.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L53) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/discount-condition.ts:130](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L130) +[models/discount-condition.ts:130](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L130) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L49) +[models/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L49) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/discount-condition.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L113) +[models/discount-condition.ts:113](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L113) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/discount-condition.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L99) +[models/discount-condition.ts:99](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L99) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/discount-condition.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L85) +[models/discount-condition.ts:85](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L85) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/discount-condition.ts:71](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L71) +[models/discount-condition.ts:71](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L71) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/discount-condition.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L43) +[models/discount-condition.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L43) ___ @@ -174,7 +174,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -188,4 +188,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L132) +[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L132) diff --git a/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md b/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md index 08d50cd93f..1bfbd124bf 100644 --- a/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md +++ b/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L20) +[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-customer-group.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L31) +[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-customer-group.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L24) +[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-customer-group.ts#L24) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L17) +[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-customer-group.ts#L17) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L28) +[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-customer-group.ts#L28) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L37) +[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-customer-group.ts#L37) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L34) +[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-customer-group.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProduct.md b/docs/content/references/entities/classes/DiscountConditionProduct.md index bda9b0c7d9..986eece683 100644 --- a/docs/content/references/entities/classes/DiscountConditionProduct.md +++ b/docs/content/references/entities/classes/DiscountConditionProduct.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L20) +[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L31) +[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L28) +[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product.ts#L28) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L37) +[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product.ts#L37) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L24) +[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product.ts#L24) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L17) +[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product.ts#L17) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L34) +[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductCollection.md b/docs/content/references/entities/classes/DiscountConditionProductCollection.md index b82989a21e..9ff292dbe3 100644 --- a/docs/content/references/entities/classes/DiscountConditionProductCollection.md +++ b/docs/content/references/entities/classes/DiscountConditionProductCollection.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L20) +[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-collection.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L31) +[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-collection.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L28) +[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-collection.ts#L28) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L37) +[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-collection.ts#L37) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L24) +[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-collection.ts#L24) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L17) +[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-collection.ts#L17) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L34) +[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-collection.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductTag.md b/docs/content/references/entities/classes/DiscountConditionProductTag.md index 92374885ca..2926874361 100644 --- a/docs/content/references/entities/classes/DiscountConditionProductTag.md +++ b/docs/content/references/entities/classes/DiscountConditionProductTag.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L20) +[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-tag.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L31) +[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-tag.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L28) +[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-tag.ts#L28) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L37) +[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-tag.ts#L37) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L24) +[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-tag.ts#L24) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L17) +[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-tag.ts#L17) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L34) +[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-tag.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountConditionProductType.md b/docs/content/references/entities/classes/DiscountConditionProductType.md index a02d1c348c..bf8a18b536 100644 --- a/docs/content/references/entities/classes/DiscountConditionProductType.md +++ b/docs/content/references/entities/classes/DiscountConditionProductType.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L20) +[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-type.ts#L20) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L31) +[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-type.ts#L31) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L28) +[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-type.ts#L28) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L37) +[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-type.ts#L37) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L24) +[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-type.ts#L24) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L17) +[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-type.ts#L17) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L34) +[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition-product-type.ts#L34) diff --git a/docs/content/references/entities/classes/DiscountRule.md b/docs/content/references/entities/classes/DiscountRule.md index c12d96a3c7..bc69080367 100644 --- a/docs/content/references/entities/classes/DiscountRule.md +++ b/docs/content/references/entities/classes/DiscountRule.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L38) +[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L38) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L41) +[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L41) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L22) +[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L22) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L44) +[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L44) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L28) +[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L28) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L31) +[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L31) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/discount-rule.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L46) +[models/discount-rule.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L46) diff --git a/docs/content/references/entities/classes/DraftOrder.md b/docs/content/references/entities/classes/DraftOrder.md index 72125dbbb9..bb8e72683c 100644 --- a/docs/content/references/entities/classes/DraftOrder.md +++ b/docs/content/references/entities/classes/DraftOrder.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/draft-order.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L54) +[models/draft-order.ts:54](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L54) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/draft-order.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L43) +[models/draft-order.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L43) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/draft-order.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L39) +[models/draft-order.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L39) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/draft-order.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L57) +[models/draft-order.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L57) ___ @@ -72,7 +72,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/draft-order.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L35) +[models/draft-order.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L35) ___ @@ -96,7 +96,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/draft-order.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L66) +[models/draft-order.ts:66](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L66) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/draft-order.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L63) +[models/draft-order.ts:63](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L63) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/draft-order.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L60) +[models/draft-order.ts:60](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L60) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/draft-order.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L51) +[models/draft-order.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L51) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/draft-order.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L47) +[models/draft-order.ts:47](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L47) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/draft-order.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L30) +[models/draft-order.ts:30](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L30) ___ @@ -170,7 +170,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -184,4 +184,4 @@ BaseEntity.updated\_at #### Defined in -[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L68) +[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L68) diff --git a/docs/content/references/entities/classes/Fulfillment.md b/docs/content/references/entities/classes/Fulfillment.md index d3a60839c4..768143ff3b 100644 --- a/docs/content/references/entities/classes/Fulfillment.md +++ b/docs/content/references/entities/classes/Fulfillment.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L79) +[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L79) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L29) +[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L29) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L25) +[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L25) ___ @@ -62,7 +62,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L73) +[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L73) ___ @@ -86,7 +86,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L85) +[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L85) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/fulfillment.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L62) +[models/fulfillment.ts:62](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L62) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L82) +[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L82) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L48) +[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L48) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L45) +[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L45) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L41) +[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L41) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/fulfillment.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L56) +[models/fulfillment.ts:56](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L56) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L52) +[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L52) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L76) +[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L76) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L37) +[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L37) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L33) +[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L33) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[models/fulfillment.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L67) +[models/fulfillment.ts:67](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L67) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L70) +[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L70) ___ @@ -230,7 +230,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -244,4 +244,4 @@ BaseEntity.updated\_at #### Defined in -[models/fulfillment.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L87) +[models/fulfillment.ts:87](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment.ts#L87) diff --git a/docs/content/references/entities/classes/FulfillmentItem.md b/docs/content/references/entities/classes/FulfillmentItem.md index 1b15a50d7c..39148bbe8b 100644 --- a/docs/content/references/entities/classes/FulfillmentItem.md +++ b/docs/content/references/entities/classes/FulfillmentItem.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L16) +[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment-item.ts#L16) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L9) +[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment-item.ts#L9) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L20) +[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment-item.ts#L20) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L12) +[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment-item.ts#L12) ___ @@ -58,4 +58,4 @@ ___ #### Defined in -[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L23) +[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment-item.ts#L23) diff --git a/docs/content/references/entities/classes/FulfillmentProvider.md b/docs/content/references/entities/classes/FulfillmentProvider.md index 769a40a651..e11f60bf0f 100644 --- a/docs/content/references/entities/classes/FulfillmentProvider.md +++ b/docs/content/references/entities/classes/FulfillmentProvider.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-provider.ts#L6) +[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment-provider.ts#L6) ___ @@ -28,4 +28,4 @@ ___ #### Defined in -[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-provider.ts#L9) +[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/fulfillment-provider.ts#L9) diff --git a/docs/content/references/entities/classes/GiftCard.md b/docs/content/references/entities/classes/GiftCard.md index 70da74c3f9..5298f7c405 100644 --- a/docs/content/references/entities/classes/GiftCard.md +++ b/docs/content/references/entities/classes/GiftCard.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L26) +[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L26) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L20) +[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L20) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L51) +[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L51) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L45) +[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L45) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L54) +[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L54) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L42) +[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L42) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L38) +[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L38) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L34) +[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L34) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L30) +[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L30) ___ @@ -164,7 +164,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L23) +[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L23) ## Methods @@ -188,4 +188,4 @@ ___ #### Defined in -[models/gift-card.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L56) +[models/gift-card.ts:56](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card.ts#L56) diff --git a/docs/content/references/entities/classes/GiftCardTransaction.md b/docs/content/references/entities/classes/GiftCardTransaction.md index 735b354391..d4c10910a2 100644 --- a/docs/content/references/entities/classes/GiftCardTransaction.md +++ b/docs/content/references/entities/classes/GiftCardTransaction.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L40) +[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L40) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L43) +[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L43) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L29) +[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L29) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L25) +[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L25) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L22) +[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L22) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L46) +[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L46) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L37) +[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L37) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L33) +[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L33) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L49) +[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L49) ## Methods @@ -112,4 +112,4 @@ ___ #### Defined in -[models/gift-card-transaction.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L51) +[models/gift-card-transaction.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/gift-card-transaction.ts#L51) diff --git a/docs/content/references/entities/classes/IdempotencyKey.md b/docs/content/references/entities/classes/IdempotencyKey.md index b7104a486e..9a7b143809 100644 --- a/docs/content/references/entities/classes/IdempotencyKey.md +++ b/docs/content/references/entities/classes/IdempotencyKey.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L23) +[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L23) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L16) +[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L16) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L20) +[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L20) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L26) +[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L26) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L44) +[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L29) +[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L29) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L32) +[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L32) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L35) +[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L35) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L41) +[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L41) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L38) +[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L38) ## Methods @@ -122,4 +122,4 @@ ___ #### Defined in -[models/idempotency-key.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L46) +[models/idempotency-key.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/idempotency-key.ts#L46) diff --git a/docs/content/references/entities/classes/Image.md b/docs/content/references/entities/classes/Image.md index aa1966f870..163f56bba2 100644 --- a/docs/content/references/entities/classes/Image.md +++ b/docs/content/references/entities/classes/Image.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/image.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/image.ts#L13) +[models/image.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/image.ts#L13) ___ @@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[models/image.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/image.ts#L10) +[models/image.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/image.ts#L10) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[models/image.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/image.ts#L15) +[models/image.ts:15](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/image.ts#L15) diff --git a/docs/content/references/entities/classes/Invite.md b/docs/content/references/entities/classes/Invite.md index 9b5dcd2e34..661c3349fe 100644 --- a/docs/content/references/entities/classes/Invite.md +++ b/docs/content/references/entities/classes/Invite.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/invite.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L23) +[models/invite.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/invite.ts#L23) ___ @@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/invite.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L29) +[models/invite.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/invite.ts#L29) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/invite.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L32) +[models/invite.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/invite.ts#L32) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/invite.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L20) +[models/invite.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/invite.ts#L20) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/invite.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L26) +[models/invite.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/invite.ts#L26) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/invite.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L12) +[models/invite.ts:12](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/invite.ts#L12) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/invite.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L34) +[models/invite.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/invite.ts#L34) diff --git a/docs/content/references/entities/classes/LineItem.md b/docs/content/references/entities/classes/LineItem.md index 8850955f21..749efffd80 100644 --- a/docs/content/references/entities/classes/LineItem.md +++ b/docs/content/references/entities/classes/LineItem.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/line-item.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L69) +[models/line-item.ts:85](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L85) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/line-item.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L90) +[models/line-item.ts:127](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L127) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/line-item.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L37) +[models/line-item.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L53) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/line-item.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L33) +[models/line-item.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L49) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/line-item.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L61) +[models/line-item.ts:77](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L77) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/line-item.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L57) +[models/line-item.ts:73](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L73) ___ @@ -92,7 +92,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/line-item.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L75) +[models/line-item.ts:112](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L112) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/line-item.ts:130](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L130) +[models/line-item.ts:167](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L167) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[models/line-item.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L110) +[models/line-item.ts:147](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L147) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[models/line-item.ts:131](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L131) +[models/line-item.ts:168](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L168) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[models/line-item.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L93) +[models/line-item.ts:130](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L130) ___ @@ -156,7 +156,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/line-item.ts:122](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L122) +[models/line-item.ts:159](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L159) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[models/line-item.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L84) +[models/line-item.ts:121](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L121) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[models/line-item.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L81) +[models/line-item.ts:118](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L118) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[models/line-item.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L119) +[models/line-item.ts:156](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L156) ___ @@ -206,17 +206,47 @@ ___ #### Defined in -[models/line-item.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L45) +[models/line-item.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L61) + +___ + +### order\_edit + +• `Optional` **order\_edit**: ``null`` \| [`OrderEdit`](OrderEdit.md) + +#### Defined in + +[models/line-item.ts:106](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L106) + +___ + +### order\_edit\_id + +• `Optional` **order\_edit\_id**: ``null`` \| `string` + +#### Defined in + +[models/line-item.ts:97](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L97) ___ ### order\_id -• **order\_id**: `string` +• **order\_id**: ``null`` \| `string` #### Defined in -[models/line-item.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L41) +[models/line-item.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L57) + +___ + +### original\_item\_id + +• `Optional` **original\_item\_id**: ``null`` \| `string` + +#### Defined in + +[models/line-item.ts:91](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L91) ___ @@ -226,7 +256,7 @@ ___ #### Defined in -[models/line-item.ts:129](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L129) +[models/line-item.ts:166](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L166) ___ @@ -236,7 +266,7 @@ ___ #### Defined in -[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L128) +[models/line-item.ts:165](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L165) ___ @@ -246,7 +276,7 @@ ___ #### Defined in -[models/line-item.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L107) +[models/line-item.ts:144](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L144) ___ @@ -256,7 +286,7 @@ ___ #### Defined in -[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L124) +[models/line-item.ts:161](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L161) ___ @@ -266,7 +296,7 @@ ___ #### Defined in -[models/line-item.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L113) +[models/line-item.ts:150](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L150) ___ @@ -276,7 +306,7 @@ ___ #### Defined in -[models/line-item.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L116) +[models/line-item.ts:153](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L153) ___ @@ -286,7 +316,7 @@ ___ #### Defined in -[models/line-item.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L87) +[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L124) ___ @@ -296,7 +326,7 @@ ___ #### Defined in -[models/line-item.ts:125](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L125) +[models/line-item.ts:162](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L162) ___ @@ -306,7 +336,7 @@ ___ #### Defined in -[models/line-item.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L53) +[models/line-item.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L69) ___ @@ -316,7 +346,7 @@ ___ #### Defined in -[models/line-item.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L49) +[models/line-item.ts:65](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L65) ___ @@ -326,7 +356,7 @@ ___ #### Defined in -[models/line-item.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L64) +[models/line-item.ts:80](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L80) ___ @@ -336,7 +366,7 @@ ___ #### Defined in -[models/line-item.ts:126](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L126) +[models/line-item.ts:163](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L163) ___ @@ -346,7 +376,7 @@ ___ #### Defined in -[models/line-item.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L78) +[models/line-item.ts:115](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L115) ___ @@ -356,7 +386,7 @@ ___ #### Defined in -[models/line-item.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L72) +[models/line-item.ts:109](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L109) ___ @@ -366,7 +396,7 @@ ___ #### Defined in -[models/line-item.ts:127](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L127) +[models/line-item.ts:164](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L164) ___ @@ -376,7 +406,7 @@ ___ #### Defined in -[models/line-item.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L96) +[models/line-item.ts:133](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L133) ___ @@ -390,7 +420,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -400,7 +430,7 @@ ___ #### Defined in -[models/line-item.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L104) +[models/line-item.ts:141](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L141) ___ @@ -410,7 +440,7 @@ ___ #### Defined in -[models/line-item.ts:100](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L100) +[models/line-item.ts:137](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L137) ## Methods @@ -424,4 +454,4 @@ ___ #### Defined in -[models/line-item.ts:133](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L133) +[models/line-item.ts:170](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item.ts#L170) diff --git a/docs/content/references/entities/classes/LineItemAdjustment.md b/docs/content/references/entities/classes/LineItemAdjustment.md index daeed6f534..952f262c3a 100644 --- a/docs/content/references/entities/classes/LineItemAdjustment.md +++ b/docs/content/references/entities/classes/LineItemAdjustment.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/line-item-adjustment.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L45) +[models/line-item-adjustment.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L45) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L34) +[models/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L34) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L38) +[models/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L38) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L42) +[models/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L42) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L23) +[models/line-item-adjustment.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L23) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L31) +[models/line-item-adjustment.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L31) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L27) +[models/line-item-adjustment.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L27) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/line-item-adjustment.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L48) +[models/line-item-adjustment.ts:48](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L48) ## Methods @@ -102,4 +102,4 @@ ___ #### Defined in -[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L50) +[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-adjustment.ts#L50) diff --git a/docs/content/references/entities/classes/LineItemTaxLine.md b/docs/content/references/entities/classes/LineItemTaxLine.md index 9ee1f66a29..5053317b27 100644 --- a/docs/content/references/entities/classes/LineItemTaxLine.md +++ b/docs/content/references/entities/classes/LineItemTaxLine.md @@ -32,7 +32,7 @@ TaxLine.code #### Defined in -[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L13) +[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-line.ts#L13) ___ @@ -46,7 +46,7 @@ TaxLine.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -60,7 +60,7 @@ TaxLine.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-tax-line.ts#L24) +[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-tax-line.ts#L24) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-tax-line.ts#L20) +[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-tax-line.ts#L20) ___ @@ -94,7 +94,7 @@ TaxLine.metadata #### Defined in -[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L16) +[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-line.ts#L16) ___ @@ -108,7 +108,7 @@ TaxLine.name #### Defined in -[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L10) +[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-line.ts#L10) ___ @@ -122,7 +122,7 @@ TaxLine.rate #### Defined in -[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L7) +[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-line.ts#L7) ___ @@ -136,7 +136,7 @@ TaxLine.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -150,4 +150,4 @@ TaxLine.updated\_at #### Defined in -[models/line-item-tax-line.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-tax-line.ts#L26) +[models/line-item-tax-line.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/line-item-tax-line.ts#L26) diff --git a/docs/content/references/entities/classes/MoneyAmount.md b/docs/content/references/entities/classes/MoneyAmount.md index 6d7c014b8f..138a0d5cd4 100644 --- a/docs/content/references/entities/classes/MoneyAmount.md +++ b/docs/content/references/entities/classes/MoneyAmount.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/money-amount.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L27) +[models/money-amount.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L28) ___ @@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/money-amount.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L24) +[models/money-amount.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L25) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/money-amount.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L20) +[models/money-amount.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L21) ___ @@ -76,7 +76,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/money-amount.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L33) +[models/money-amount.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L34) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/money-amount.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L30) +[models/money-amount.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L31) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/money-amount.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L43) +[models/money-amount.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L44) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/money-amount.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L36) +[models/money-amount.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L37) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/money-amount.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L61) +[models/money-amount.ts:62](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L62) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/money-amount.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L57) +[models/money-amount.ts:58](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L58) ___ @@ -164,7 +164,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[models/money-amount.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L53) +[models/money-amount.ts:54](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L54) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[models/money-amount.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L47) +[models/money-amount.ts:48](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L48) ## Methods @@ -198,4 +198,4 @@ ___ #### Defined in -[models/money-amount.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L63) +[models/money-amount.ts:64](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/money-amount.ts#L64) diff --git a/docs/content/references/entities/classes/Note.md b/docs/content/references/entities/classes/Note.md index ca6d04df0c..68b407f7ab 100644 --- a/docs/content/references/entities/classes/Note.md +++ b/docs/content/references/entities/classes/Note.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/note.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/note.ts#L33) +[models/note.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/note.ts#L33) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/note.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/note.ts#L29) +[models/note.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/note.ts#L29) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/note.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/note.ts#L36) +[models/note.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/note.ts#L36) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/note.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/note.ts#L26) +[models/note.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/note.ts#L26) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/note.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/note.ts#L22) +[models/note.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/note.ts#L22) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/note.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/note.ts#L18) +[models/note.ts:18](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/note.ts#L18) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/note.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/note.ts#L38) +[models/note.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/note.ts#L38) diff --git a/docs/content/references/entities/classes/Notification.md b/docs/content/references/entities/classes/Notification.md index b3b6cce496..57afcb3a10 100644 --- a/docs/content/references/entities/classes/Notification.md +++ b/docs/content/references/entities/classes/Notification.md @@ -32,7 +32,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/notification.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L36) +[models/notification.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L36) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/notification.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L32) +[models/notification.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L32) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/notification.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L42) +[models/notification.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L42) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/notification.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L20) +[models/notification.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L20) ___ @@ -86,7 +86,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/notification.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L45) +[models/notification.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L45) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/notification.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L49) +[models/notification.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L49) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/notification.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L59) +[models/notification.ts:59](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L59) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/notification.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L55) +[models/notification.ts:55](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L55) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/notification.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L52) +[models/notification.ts:52](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L52) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/notification.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L28) +[models/notification.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L28) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/notification.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L24) +[models/notification.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L24) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/notification.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L39) +[models/notification.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L39) ___ @@ -180,7 +180,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -194,4 +194,4 @@ BaseEntity.updated\_at #### Defined in -[models/notification.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/notification.ts#L61) +[models/notification.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/notification.ts#L61) diff --git a/docs/content/references/entities/classes/Oauth.md b/docs/content/references/entities/classes/Oauth.md index 2c6493c1e9..57ffa2fc5c 100644 --- a/docs/content/references/entities/classes/Oauth.md +++ b/docs/content/references/entities/classes/Oauth.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/oauth.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/oauth.ts#L16) +[models/oauth.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/oauth.ts#L16) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/oauth.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/oauth.ts#L25) +[models/oauth.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/oauth.ts#L25) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/oauth.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/oauth.ts#L12) +[models/oauth.ts:12](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/oauth.ts#L12) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/oauth.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/oauth.ts#L9) +[models/oauth.ts:9](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/oauth.ts#L9) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/oauth.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/oauth.ts#L19) +[models/oauth.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/oauth.ts#L19) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/oauth.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/oauth.ts#L22) +[models/oauth.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/oauth.ts#L22) ## Methods @@ -82,4 +82,4 @@ ___ #### Defined in -[models/oauth.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/oauth.ts#L27) +[models/oauth.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/oauth.ts#L27) diff --git a/docs/content/references/entities/classes/Order.md b/docs/content/references/entities/classes/Order.md index a96538b582..e687bf9c3c 100644 --- a/docs/content/references/entities/classes/Order.md +++ b/docs/content/references/entities/classes/Order.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/order.ts:125](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L125) +[models/order.ts:125](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L125) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/order.ts:121](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L121) +[models/order.ts:121](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L121) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/order.ts:230](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L230) +[models/order.ts:231](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L231) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/order.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L106) +[models/order.ts:106](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L106) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/order.ts:102](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L102) +[models/order.ts:102](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L102) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/order.ts:198](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L198) +[models/order.ts:199](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L199) ___ @@ -92,7 +92,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/order.ts:148](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L148) +[models/order.ts:149](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L149) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/order.ts:144](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L144) +[models/order.ts:145](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L145) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[models/order.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L114) +[models/order.ts:114](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L114) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[models/order.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L110) +[models/order.ts:110](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L110) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[models/order.ts:255](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L255) +[models/order.ts:256](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L256) ___ @@ -152,7 +152,7 @@ ___ #### Defined in -[models/order.ts:165](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L165) +[models/order.ts:166](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L166) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[models/order.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L98) +[models/order.ts:98](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L98) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[models/order.ts:211](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L211) +[models/order.ts:212](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L212) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[models/order.ts:207](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L207) +[models/order.ts:208](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L208) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[models/order.ts:219](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L219) +[models/order.ts:220](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L220) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[models/order.ts:117](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L117) +[models/order.ts:117](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L117) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[models/order.ts:242](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L242) +[models/order.ts:243](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L243) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[models/order.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L90) +[models/order.ts:90](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L90) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[models/order.ts:192](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L192) +[models/order.ts:193](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L193) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[models/order.ts:263](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L263) +[models/order.ts:264](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L264) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[models/order.ts:262](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L262) +[models/order.ts:263](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L263) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[models/order.ts:227](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L227) +[models/order.ts:228](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L228) ___ @@ -272,7 +272,7 @@ ___ #### Defined in -[models/order.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L179) +[models/order.ts:180](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L180) ___ @@ -286,7 +286,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -[models/order.ts:239](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L239) +[models/order.ts:240](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L240) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[models/order.ts:224](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L224) +[models/order.ts:225](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L225) ___ @@ -316,7 +316,7 @@ ___ #### Defined in -[models/order.ts:233](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L233) +[models/order.ts:234](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L234) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[models/order.ts:236](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L236) +[models/order.ts:237](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L237) ___ @@ -336,7 +336,7 @@ ___ #### Defined in -[models/order.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L80) +[models/order.ts:80](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L80) ___ @@ -346,7 +346,7 @@ ___ #### Defined in -[models/order.ts:260](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L260) +[models/order.ts:261](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L261) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[models/order.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L93) +[models/order.ts:93](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L93) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[models/order.ts:187](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L187) +[models/order.ts:188](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L188) ___ @@ -376,7 +376,7 @@ ___ #### Defined in -[models/order.ts:261](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L261) +[models/order.ts:262](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L262) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[models/order.ts:257](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L257) +[models/order.ts:258](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L258) ___ @@ -396,7 +396,7 @@ ___ #### Defined in -[models/order.ts:201](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L201) +[models/order.ts:202](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L202) ___ @@ -406,7 +406,7 @@ ___ #### Defined in -[models/order.ts:141](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L141) +[models/order.ts:141](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L141) ___ @@ -416,7 +416,7 @@ ___ #### Defined in -[models/order.ts:137](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L137) +[models/order.ts:137](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L137) ___ @@ -426,7 +426,7 @@ ___ #### Defined in -[models/order.ts:195](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L195) +[models/order.ts:196](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L196) ___ @@ -436,7 +436,7 @@ ___ #### Defined in -[models/order.ts:251](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L251) +[models/order.ts:252](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L252) ___ @@ -446,7 +446,7 @@ ___ #### Defined in -[models/order.ts:245](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L245) +[models/order.ts:246](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L246) ___ @@ -456,7 +456,7 @@ ___ #### Defined in -[models/order.ts:133](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L133) +[models/order.ts:133](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L133) ___ @@ -466,7 +466,7 @@ ___ #### Defined in -[models/order.ts:129](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L129) +[models/order.ts:129](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L129) ___ @@ -476,7 +476,7 @@ ___ #### Defined in -[models/order.ts:184](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L184) +[models/order.ts:185](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L185) ___ @@ -486,7 +486,7 @@ ___ #### Defined in -[models/order.ts:254](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L254) +[models/order.ts:255](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L255) ___ @@ -496,7 +496,7 @@ ___ #### Defined in -[models/order.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L83) +[models/order.ts:83](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L83) ___ @@ -506,7 +506,7 @@ ___ #### Defined in -[models/order.ts:259](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L259) +[models/order.ts:260](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L260) ___ @@ -516,7 +516,7 @@ ___ #### Defined in -[models/order.ts:204](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L204) +[models/order.ts:205](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L205) ___ @@ -526,7 +526,7 @@ ___ #### Defined in -[models/order.ts:151](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L151) +[models/order.ts:152](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L152) ___ @@ -536,7 +536,7 @@ ___ #### Defined in -[models/order.ts:256](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L256) +[models/order.ts:257](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L257) ___ @@ -546,7 +546,7 @@ ___ #### Defined in -[models/order.ts:258](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L258) +[models/order.ts:259](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L259) ___ @@ -560,7 +560,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -574,4 +574,4 @@ BaseEntity.updated\_at #### Defined in -[models/order.ts:265](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L265) +[models/order.ts:266](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L266) diff --git a/docs/content/references/entities/classes/OrderEdit.md b/docs/content/references/entities/classes/OrderEdit.md index 03b1b8fd7d..2093258bf2 100644 --- a/docs/content/references/entities/classes/OrderEdit.md +++ b/docs/content/references/entities/classes/OrderEdit.md @@ -6,7 +6,7 @@ displayed_sidebar: entitiesSidebar ## Hierarchy -- `SoftDeletableEntity` +- `BaseEntity` ↳ **`OrderEdit`** @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Inherited from -SoftDeletableEntity.constructor +BaseEntity.constructor ## Properties @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/order-edit.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L57) +[models/order-edit.ts:74](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L74) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/order-edit.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L54) +[models/order-edit.ts:71](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L71) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/order-edit.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L24) +[models/order-edit.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L41) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/order-edit.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L42) +[models/order-edit.ts:59](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L59) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/order-edit.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L39) +[models/order-edit.ts:56](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L56) ___ @@ -78,11 +78,11 @@ ___ #### Inherited from -SoftDeletableEntity.created\_at +BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[models/order-edit.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L30) +[models/order-edit.ts:47](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L47) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/order-edit.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L51) +[models/order-edit.ts:68](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L68) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/order-edit.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L45) +[models/order-edit.ts:62](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L62) ___ @@ -122,21 +122,7 @@ ___ #### Defined in -[models/order-edit.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L48) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[models/order-edit.ts:65](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L65) ___ @@ -146,17 +132,37 @@ ___ #### Defined in -[models/order-edit.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L64) +[models/order-edit.ts:96](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L96) ___ ### discount\_total -• `Optional` **discount\_total**: `number` +• **discount\_total**: `number` #### Defined in -[models/order-edit.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L61) +[models/order-edit.ts:89](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L89) + +___ + +### gift\_card\_tax\_total + +• **gift\_card\_tax\_total**: `number` + +#### Defined in + +[models/order-edit.ts:94](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L94) + +___ + +### gift\_card\_total + +• **gift\_card\_total**: `number` + +#### Defined in + +[models/order-edit.ts:93](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L93) ___ @@ -166,11 +172,11 @@ ___ #### Inherited from -SoftDeletableEntity.id +BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -180,7 +186,7 @@ ___ #### Defined in -[models/order-edit.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L27) +[models/order-edit.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L44) ___ @@ -190,7 +196,7 @@ ___ #### Defined in -[models/order-edit.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L66) +[models/order-edit.ts:77](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L77) ___ @@ -200,7 +206,7 @@ ___ #### Defined in -[models/order-edit.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L19) +[models/order-edit.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L36) ___ @@ -210,17 +216,27 @@ ___ #### Defined in -[models/order-edit.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L15) +[models/order-edit.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L32) ___ -### removed\_items +### payment\_collection -• **removed\_items**: [`LineItem`](LineItem.md)[] +• **payment\_collection**: [`PaymentCollection`](PaymentCollection.md) #### Defined in -[models/order-edit.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L67) +[models/order-edit.ts:85](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L85) + +___ + +### payment\_collection\_id + +• **payment\_collection\_id**: `string` + +#### Defined in + +[models/order-edit.ts:81](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L81) ___ @@ -230,7 +246,7 @@ ___ #### Defined in -[models/order-edit.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L36) +[models/order-edit.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L53) ___ @@ -240,7 +256,27 @@ ___ #### Defined in -[models/order-edit.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L33) +[models/order-edit.ts:50](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L50) + +___ + +### shipping\_total + +• **shipping\_total**: `number` + +#### Defined in + +[models/order-edit.ts:88](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L88) + +___ + +### status + +• **status**: [`OrderEditStatus`](../enums/OrderEditStatus.md) + +#### Defined in + +[models/order-edit.ts:98](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L98) ___ @@ -250,17 +286,17 @@ ___ #### Defined in -[models/order-edit.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L60) +[models/order-edit.ts:92](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L92) ___ ### tax\_total -• **tax\_total**: `number` +• **tax\_total**: ``null`` \| `number` #### Defined in -[models/order-edit.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L62) +[models/order-edit.ts:90](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L90) ___ @@ -270,7 +306,7 @@ ___ #### Defined in -[models/order-edit.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L63) +[models/order-edit.ts:91](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L91) ___ @@ -280,11 +316,11 @@ ___ #### Inherited from -SoftDeletableEntity.updated\_at +BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -298,4 +334,18 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/order-edit.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-edit.ts#L69) +[models/order-edit.ts:100](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L100) + +___ + +### loadStatus + +▸ **loadStatus**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/order-edit.ts:105](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L105) diff --git a/docs/content/references/entities/classes/OrderItemChange.md b/docs/content/references/entities/classes/OrderItemChange.md index 165fd5b848..2c9761b237 100644 --- a/docs/content/references/entities/classes/OrderItemChange.md +++ b/docs/content/references/entities/classes/OrderItemChange.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/order-item-change.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L53) +[models/order-item-change.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L53) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/order-item-change.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L49) +[models/order-item-change.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L49) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/order-item-change.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L39) +[models/order-item-change.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L39) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/order-item-change.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L35) +[models/order-item-change.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L35) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/order-item-change.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L46) +[models/order-item-change.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L46) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/order-item-change.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L42) +[models/order-item-change.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L42) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/order-item-change.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L32) +[models/order-item-change.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L32) ___ @@ -144,7 +144,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -158,4 +158,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/order-item-change.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L55) +[models/order-item-change.ts:55](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L55) diff --git a/docs/content/references/entities/classes/Payment.md b/docs/content/references/entities/classes/Payment.md index ef98972866..283d0dc215 100644 --- a/docs/content/references/entities/classes/Payment.md +++ b/docs/content/references/entities/classes/Payment.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/payment.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L51) +[models/payment.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L51) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/payment.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L61) +[models/payment.ts:62](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L62) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/payment.ts:74](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L74) +[models/payment.ts:75](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L75) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/payment.ts:71](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L71) +[models/payment.ts:72](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L72) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/payment.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L37) +[models/payment.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L40) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/payment.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L33) +[models/payment.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L36) ___ @@ -92,7 +92,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[models/payment.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L58) +[models/payment.ts:59](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L59) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/payment.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L54) +[models/payment.ts:55](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L55) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[models/payment.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L68) +[models/payment.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L69) ___ @@ -136,7 +136,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/payment.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L80) +[models/payment.ts:81](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L81) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/payment.ts:77](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L77) +[models/payment.ts:78](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L78) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/payment.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L48) +[models/payment.ts:48](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L48) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[models/payment.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L41) +[models/payment.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L44) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[models/payment.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L65) +[models/payment.ts:66](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L66) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[models/payment.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L29) +[models/payment.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L32) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[models/payment.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L25) +[models/payment.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L28) ___ @@ -220,7 +220,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -234,4 +234,4 @@ BaseEntity.updated\_at #### Defined in -[models/payment.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment.ts#L82) +[models/payment.ts:83](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment.ts#L83) diff --git a/docs/content/references/entities/classes/PaymentCollection.md b/docs/content/references/entities/classes/PaymentCollection.md new file mode 100644 index 0000000000..d44a862264 --- /dev/null +++ b/docs/content/references/entities/classes/PaymentCollection.md @@ -0,0 +1,231 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Class: PaymentCollection + +## Hierarchy + +- `SoftDeletableEntity` + + ↳ **`PaymentCollection`** + +## Constructors + +### constructor + +• **new PaymentCollection**() + +#### Inherited from + +SoftDeletableEntity.constructor + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[models/payment-collection.ts:48](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L48) + +___ + +### authorized\_amount + +• **authorized\_amount**: `number` + +#### Defined in + +[models/payment-collection.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L51) + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.created\_at + +#### Defined in + +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) + +___ + +### created\_by + +• **created\_by**: `string` + +#### Defined in + +[models/payment-collection.ts:104](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L104) + +___ + +### currency + +• **currency**: [`Currency`](Currency.md) + +#### Defined in + +[models/payment-collection.ts:70](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L70) + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +[models/payment-collection.ts:66](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L66) + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +SoftDeletableEntity.deleted\_at + +#### Defined in + +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) + +___ + +### description + +• **description**: `string` + +#### Defined in + +[models/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L45) + +___ + +### id + +• **id**: `string` + +#### Inherited from + +SoftDeletableEntity.id + +#### Defined in + +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) + +___ + +### metadata + +• **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +[models/payment-collection.ts:101](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L101) + +___ + +### payment\_sessions + +• **payment\_sessions**: [`PaymentSession`](PaymentSession.md)[] + +#### Defined in + +[models/payment-collection.ts:84](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L84) + +___ + +### payments + +• **payments**: [`Payment`](Payment.md)[] + +#### Defined in + +[models/payment-collection.ts:98](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L98) + +___ + +### refunded\_amount + +• **refunded\_amount**: `number` + +#### Defined in + +[models/payment-collection.ts:54](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L54) + +___ + +### region + +• **region**: [`Region`](Region.md) + +#### Defined in + +[models/payment-collection.ts:62](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L62) + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +[models/payment-collection.ts:58](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L58) + +___ + +### status + +• **status**: [`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.md) + +#### Defined in + +[models/payment-collection.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L42) + +___ + +### type + +• **type**: [`ORDER_EDIT`](../enums/PaymentCollectionType.md#order_edit) + +#### Defined in + +[models/payment-collection.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L39) + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +SoftDeletableEntity.updated\_at + +#### Defined in + +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) + +## Methods + +### beforeInsert + +▸ `Private` **beforeInsert**(): `void` + +#### Returns + +`void` + +#### Defined in + +[models/payment-collection.ts:106](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L106) diff --git a/docs/content/references/entities/classes/PaymentProvider.md b/docs/content/references/entities/classes/PaymentProvider.md index 63f398066d..98626e428e 100644 --- a/docs/content/references/entities/classes/PaymentProvider.md +++ b/docs/content/references/entities/classes/PaymentProvider.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/payment-provider.ts:6](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-provider.ts#L6) +[models/payment-provider.ts:6](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-provider.ts#L6) ___ @@ -28,4 +28,4 @@ ___ #### Defined in -[models/payment-provider.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-provider.ts#L9) +[models/payment-provider.ts:9](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-provider.ts#L9) diff --git a/docs/content/references/entities/classes/PaymentSession.md b/docs/content/references/entities/classes/PaymentSession.md index 44c3434488..c3e5dd6ad1 100644 --- a/docs/content/references/entities/classes/PaymentSession.md +++ b/docs/content/references/entities/classes/PaymentSession.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/payment-session.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L34) +[models/payment-session.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L36) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/payment-session.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L30) +[models/payment-session.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L32) ___ @@ -52,7 +52,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/payment-session.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L47) +[models/payment-session.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L49) ___ @@ -76,7 +76,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/payment-session.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L50) +[models/payment-session.ts:52](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L52) ___ @@ -96,7 +96,17 @@ ___ #### Defined in -[models/payment-session.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L41) +[models/payment-session.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L43) + +___ + +### payment\_authorized\_at + +• **payment\_authorized\_at**: `Date` + +#### Defined in + +[models/payment-session.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L57) ___ @@ -106,7 +116,7 @@ ___ #### Defined in -[models/payment-session.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L38) +[models/payment-session.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L40) ___ @@ -116,7 +126,7 @@ ___ #### Defined in -[models/payment-session.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L44) +[models/payment-session.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L46) ___ @@ -130,7 +140,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -144,4 +154,4 @@ BaseEntity.updated\_at #### Defined in -[models/payment-session.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L52) +[models/payment-session.ts:59](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L59) diff --git a/docs/content/references/entities/classes/PriceList.md b/docs/content/references/entities/classes/PriceList.md index 56810bfaa4..3cb336ea05 100644 --- a/docs/content/references/entities/classes/PriceList.md +++ b/docs/content/references/entities/classes/PriceList.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/price-list.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L56) +[models/price-list.ts:56](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L56) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/price-list.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L25) +[models/price-list.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L25) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/price-list.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L40) +[models/price-list.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L40) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/price-list.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L64) +[models/price-list.ts:64](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L64) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/price-list.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L22) +[models/price-list.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L22) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/price-list.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L61) +[models/price-list.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L61) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/price-list.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L37) +[models/price-list.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L37) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/price-list.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L31) +[models/price-list.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L31) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/price-list.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L28) +[models/price-list.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L28) ___ @@ -164,7 +164,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -178,4 +178,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/price-list.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/price-list.ts#L66) +[models/price-list.ts:66](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/price-list.ts#L66) diff --git a/docs/content/references/entities/classes/Product.md b/docs/content/references/entities/classes/Product.md index edf2d8efac..c7be6a1ff7 100644 --- a/docs/content/references/entities/classes/Product.md +++ b/docs/content/references/entities/classes/Product.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/product.ts:117](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L117) +[models/product.ts:117](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L117) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/product.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L113) +[models/product.ts:113](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L113) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/product.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L43) +[models/product.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L43) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/product.ts:141](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L141) +[models/product.ts:141](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L141) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/product.ts:144](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L144) +[models/product.ts:144](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L144) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/product.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L47) +[models/product.ts:47](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L47) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/product.ts:95](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L95) +[models/product.ts:95](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L95) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/product.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L101) +[models/product.ts:101](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L101) ___ @@ -140,7 +140,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/product.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L67) +[models/product.ts:67](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L67) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/product.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L50) +[models/product.ts:50](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L50) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/product.ts:92](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L92) +[models/product.ts:92](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L92) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/product.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L110) +[models/product.ts:110](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L110) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/product.ts:147](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L147) +[models/product.ts:147](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L147) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/product.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L107) +[models/product.ts:107](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L107) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/product.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L73) +[models/product.ts:73](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L73) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/product.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L104) +[models/product.ts:104](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L104) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/product.ts:86](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L86) +[models/product.ts:86](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L86) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[models/product.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L82) +[models/product.ts:82](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L82) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[models/product.ts:163](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L163) +[models/product.ts:163](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L163) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[models/product.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L53) +[models/product.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L53) ___ @@ -270,7 +270,7 @@ ___ #### Defined in -[models/product.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L40) +[models/product.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L40) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[models/product.ts:138](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L138) +[models/product.ts:138](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L138) ___ @@ -290,7 +290,7 @@ ___ #### Defined in -[models/product.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L70) +[models/product.ts:70](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L70) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[models/product.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L37) +[models/product.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L37) ___ @@ -310,7 +310,7 @@ ___ #### Defined in -[models/product.ts:124](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L124) +[models/product.ts:124](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L124) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[models/product.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L120) +[models/product.ts:120](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L120) ___ @@ -334,7 +334,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -344,7 +344,7 @@ ___ #### Defined in -[models/product.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L78) +[models/product.ts:78](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L78) ___ @@ -354,7 +354,7 @@ ___ #### Defined in -[models/product.ts:89](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L89) +[models/product.ts:89](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L89) ___ @@ -364,7 +364,7 @@ ___ #### Defined in -[models/product.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L98) +[models/product.ts:98](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L98) ## Methods @@ -378,4 +378,4 @@ ___ #### Defined in -[models/product.ts:165](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L165) +[models/product.ts:165](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L165) diff --git a/docs/content/references/entities/classes/ProductCollection.md b/docs/content/references/entities/classes/ProductCollection.md index ce0aa83746..c21181a79b 100644 --- a/docs/content/references/entities/classes/ProductCollection.md +++ b/docs/content/references/entities/classes/ProductCollection.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[models/product-collection.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-collection.ts#L16) +[models/product-collection.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-collection.ts#L16) ___ @@ -70,7 +70,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/product-collection.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-collection.ts#L22) +[models/product-collection.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-collection.ts#L22) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/product-collection.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-collection.ts#L19) +[models/product-collection.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-collection.ts#L19) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/product-collection.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-collection.ts#L12) +[models/product-collection.ts:12](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-collection.ts#L12) ___ @@ -114,7 +114,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -128,4 +128,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/product-collection.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-collection.ts#L24) +[models/product-collection.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-collection.ts#L24) diff --git a/docs/content/references/entities/classes/ProductOption.md b/docs/content/references/entities/classes/ProductOption.md index 66d0130667..6d491dffb2 100644 --- a/docs/content/references/entities/classes/ProductOption.md +++ b/docs/content/references/entities/classes/ProductOption.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/product-option.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option.ts#L32) +[models/product-option.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option.ts#L32) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/product-option.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option.ts#L29) +[models/product-option.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option.ts#L29) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/product-option.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option.ts#L25) +[models/product-option.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option.ts#L25) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/product-option.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option.ts#L19) +[models/product-option.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option.ts#L19) ___ @@ -114,7 +114,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[models/product-option.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option.ts#L22) +[models/product-option.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option.ts#L22) ## Methods @@ -138,4 +138,4 @@ ___ #### Defined in -[models/product-option.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option.ts#L34) +[models/product-option.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option.ts#L34) diff --git a/docs/content/references/entities/classes/ProductOptionValue.md b/docs/content/references/entities/classes/ProductOptionValue.md index ad0a9934b2..b1b8e4e16b 100644 --- a/docs/content/references/entities/classes/ProductOptionValue.md +++ b/docs/content/references/entities/classes/ProductOptionValue.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/product-option-value.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option-value.ts#L40) +[models/product-option-value.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option-value.ts#L40) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/product-option-value.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option-value.ts#L27) +[models/product-option-value.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option-value.ts#L27) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/product-option-value.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option-value.ts#L23) +[models/product-option-value.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option-value.ts#L23) ___ @@ -104,7 +104,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[models/product-option-value.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option-value.ts#L19) +[models/product-option-value.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option-value.ts#L19) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[models/product-option-value.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option-value.ts#L37) +[models/product-option-value.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option-value.ts#L37) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/product-option-value.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option-value.ts#L31) +[models/product-option-value.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option-value.ts#L31) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/product-option-value.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-option-value.ts#L42) +[models/product-option-value.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-option-value.ts#L42) diff --git a/docs/content/references/entities/classes/ProductTag.md b/docs/content/references/entities/classes/ProductTag.md index 7eebbb0760..2f6cf47c0d 100644 --- a/docs/content/references/entities/classes/ProductTag.md +++ b/docs/content/references/entities/classes/ProductTag.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/product-tag.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tag.ts#L13) +[models/product-tag.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tag.ts#L13) ___ @@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[models/product-tag.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tag.ts#L10) +[models/product-tag.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tag.ts#L10) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[models/product-tag.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tag.ts#L15) +[models/product-tag.ts:15](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tag.ts#L15) diff --git a/docs/content/references/entities/classes/ProductTaxRate.md b/docs/content/references/entities/classes/ProductTaxRate.md index 100c8751bc..6b4c7b1359 100644 --- a/docs/content/references/entities/classes/ProductTaxRate.md +++ b/docs/content/references/entities/classes/ProductTaxRate.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/product-tax-rate.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tax-rate.ts#L32) +[models/product-tax-rate.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tax-rate.ts#L32) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tax-rate.ts#L38) +[models/product-tax-rate.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tax-rate.ts#L38) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tax-rate.ts#L24) +[models/product-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tax-rate.ts#L24) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tax-rate.ts#L17) +[models/product-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tax-rate.ts#L17) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tax-rate.ts#L20) +[models/product-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tax-rate.ts#L20) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/product-tax-rate.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tax-rate.ts#L29) +[models/product-tax-rate.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tax-rate.ts#L29) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/product-tax-rate.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-tax-rate.ts#L35) +[models/product-tax-rate.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-tax-rate.ts#L35) diff --git a/docs/content/references/entities/classes/ProductType.md b/docs/content/references/entities/classes/ProductType.md index 6703e33185..23265ed5c0 100644 --- a/docs/content/references/entities/classes/ProductType.md +++ b/docs/content/references/entities/classes/ProductType.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/product-type.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type.ts#L13) +[models/product-type.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type.ts#L13) ___ @@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[models/product-type.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type.ts#L10) +[models/product-type.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type.ts#L10) ## Methods @@ -108,4 +108,4 @@ ___ #### Defined in -[models/product-type.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type.ts#L15) +[models/product-type.ts:15](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type.ts#L15) diff --git a/docs/content/references/entities/classes/ProductTypeTaxRate.md b/docs/content/references/entities/classes/ProductTypeTaxRate.md index 00bc1a713a..4cc4c4f7ba 100644 --- a/docs/content/references/entities/classes/ProductTypeTaxRate.md +++ b/docs/content/references/entities/classes/ProductTypeTaxRate.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/product-type-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type-tax-rate.ts#L31) +[models/product-type-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type-tax-rate.ts#L31) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type-tax-rate.ts#L37) +[models/product-type-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type-tax-rate.ts#L37) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type-tax-rate.ts#L24) +[models/product-type-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type-tax-rate.ts#L24) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type-tax-rate.ts#L17) +[models/product-type-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type-tax-rate.ts#L17) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type-tax-rate.ts#L20) +[models/product-type-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type-tax-rate.ts#L20) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type-tax-rate.ts#L28) +[models/product-type-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type-tax-rate.ts#L28) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/product-type-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-type-tax-rate.ts#L34) +[models/product-type-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-type-tax-rate.ts#L34) diff --git a/docs/content/references/entities/classes/ProductVariant.md b/docs/content/references/entities/classes/ProductVariant.md index 725aad353c..d26a37fa5a 100644 --- a/docs/content/references/entities/classes/ProductVariant.md +++ b/docs/content/references/entities/classes/ProductVariant.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/product-variant.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L60) +[models/product-variant.ts:60](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L60) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/product-variant.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L43) +[models/product-variant.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L43) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/product-variant.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L47) +[models/product-variant.ts:47](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L47) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/product-variant.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L84) +[models/product-variant.ts:84](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L84) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/product-variant.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L66) +[models/product-variant.ts:66](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L66) ___ @@ -110,7 +110,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/product-variant.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L57) +[models/product-variant.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L57) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/product-variant.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L81) +[models/product-variant.ts:81](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L81) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/product-variant.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L63) +[models/product-variant.ts:63](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L63) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/product-variant.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L75) +[models/product-variant.ts:75](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L75) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/product-variant.ts:95](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L95) +[models/product-variant.ts:95](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L95) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/product-variant.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L72) +[models/product-variant.ts:72](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L72) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/product-variant.ts:92](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L92) +[models/product-variant.ts:92](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L92) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/product-variant.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L69) +[models/product-variant.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L69) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/product-variant.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L35) +[models/product-variant.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L35) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/product-variant.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L29) +[models/product-variant.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L29) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/product-variant.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L25) +[models/product-variant.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L25) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/product-variant.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L39) +[models/product-variant.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L39) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[models/product-variant.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L21) +[models/product-variant.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L21) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[models/product-variant.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L51) +[models/product-variant.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L51) ___ @@ -264,7 +264,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -274,7 +274,7 @@ ___ #### Defined in -[models/product-variant.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L54) +[models/product-variant.ts:54](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L54) ___ @@ -284,7 +284,7 @@ ___ #### Defined in -[models/product-variant.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L78) +[models/product-variant.ts:78](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L78) ___ @@ -294,7 +294,7 @@ ___ #### Defined in -[models/product-variant.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L87) +[models/product-variant.ts:87](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L87) ## Methods @@ -308,4 +308,4 @@ ___ #### Defined in -[models/product-variant.ts:97](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product-variant.ts#L97) +[models/product-variant.ts:97](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product-variant.ts#L97) diff --git a/docs/content/references/entities/classes/Refund.md b/docs/content/references/entities/classes/Refund.md index 1c16a461fd..4eaf9df10d 100644 --- a/docs/content/references/entities/classes/Refund.md +++ b/docs/content/references/entities/classes/Refund.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/refund.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L34) +[models/refund.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L34) ___ @@ -42,7 +42,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/refund.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L46) +[models/refund.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L46) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/refund.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L43) +[models/refund.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L43) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/refund.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L37) +[models/refund.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L37) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/refund.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L31) +[models/refund.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L31) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/refund.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L27) +[models/refund.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L27) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/refund.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L40) +[models/refund.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L40) ___ @@ -130,7 +130,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -144,4 +144,4 @@ BaseEntity.updated\_at #### Defined in -[models/refund.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L48) +[models/refund.ts:48](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L48) diff --git a/docs/content/references/entities/classes/Region.md b/docs/content/references/entities/classes/Region.md index 100b939273..53c42b3020 100644 --- a/docs/content/references/entities/classes/Region.md +++ b/docs/content/references/entities/classes/Region.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/region.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L49) +[models/region.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L51) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/region.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L52) +[models/region.ts:54](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L54) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/region.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L34) +[models/region.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L36) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/region.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L30) +[models/region.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L32) ___ @@ -86,7 +86,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/region.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L93) +[models/region.ts:95](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L95) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/region.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L46) +[models/region.ts:48](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L48) ___ @@ -120,7 +120,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/region.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L99) +[models/region.ts:101](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L101) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/region.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L96) +[models/region.ts:98](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L98) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/region.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L27) +[models/region.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L28) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/region.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L76) +[models/region.ts:78](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L78) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/region.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L43) +[models/region.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L45) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/region.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L59) +[models/region.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L61) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/region.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L55) +[models/region.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L57) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/region.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L37) +[models/region.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L39) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/region.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L40) +[models/region.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L42) ___ @@ -224,7 +224,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -238,4 +238,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/region.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/region.ts#L101) +[models/region.ts:103](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/region.ts#L103) diff --git a/docs/content/references/entities/classes/Return.md b/docs/content/references/entities/classes/Return.md index 5d685fe42b..1881f1c46f 100644 --- a/docs/content/references/entities/classes/Return.md +++ b/docs/content/references/entities/classes/Return.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/return.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L57) +[models/return.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L57) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/return.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L53) +[models/return.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L53) ___ @@ -52,7 +52,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -66,7 +66,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/return.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L88) +[models/return.ts:88](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L88) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/return.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L41) +[models/return.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L41) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/return.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L85) +[models/return.ts:85](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L85) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/return.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L82) +[models/return.ts:82](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L82) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/return.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L65) +[models/return.ts:65](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L65) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/return.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L61) +[models/return.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L61) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/return.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L79) +[models/return.ts:79](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L79) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/return.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L76) +[models/return.ts:76](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L76) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/return.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L73) +[models/return.ts:73](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L73) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/return.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L70) +[models/return.ts:70](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L70) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[models/return.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L35) +[models/return.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L35) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[models/return.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L49) +[models/return.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L49) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[models/return.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L45) +[models/return.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L45) ___ @@ -210,7 +210,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -224,4 +224,4 @@ BaseEntity.updated\_at #### Defined in -[models/return.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L90) +[models/return.ts:90](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L90) diff --git a/docs/content/references/entities/classes/ReturnItem.md b/docs/content/references/entities/classes/ReturnItem.md index 022ccb1128..fe2d8b550d 100644 --- a/docs/content/references/entities/classes/ReturnItem.md +++ b/docs/content/references/entities/classes/ReturnItem.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/return-item.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L28) +[models/return-item.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L28) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/return-item.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L22) +[models/return-item.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L22) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/return-item.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L14) +[models/return-item.ts:14](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L14) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/return-item.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L47) +[models/return-item.ts:47](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L47) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/return-item.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L44) +[models/return-item.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L44) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/return-item.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L25) +[models/return-item.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L25) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/return-item.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L41) +[models/return-item.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L41) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/return-item.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L37) +[models/return-item.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L37) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[models/return-item.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L34) +[models/return-item.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L34) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[models/return-item.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L31) +[models/return-item.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L31) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[models/return-item.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L11) +[models/return-item.ts:11](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L11) ___ @@ -128,4 +128,4 @@ ___ #### Defined in -[models/return-item.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-item.ts#L18) +[models/return-item.ts:18](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-item.ts#L18) diff --git a/docs/content/references/entities/classes/ReturnReason.md b/docs/content/references/entities/classes/ReturnReason.md index 2950248520..7dbc7f451d 100644 --- a/docs/content/references/entities/classes/ReturnReason.md +++ b/docs/content/references/entities/classes/ReturnReason.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[models/return-reason.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-reason.ts#L25) +[models/return-reason.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-reason.ts#L25) ___ @@ -70,7 +70,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/return-reason.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-reason.ts#L22) +[models/return-reason.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-reason.ts#L22) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/return-reason.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-reason.ts#L42) +[models/return-reason.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-reason.ts#L42) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/return-reason.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-reason.ts#L32) +[models/return-reason.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-reason.ts#L32) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/return-reason.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-reason.ts#L28) +[models/return-reason.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-reason.ts#L28) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/return-reason.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-reason.ts#L39) +[models/return-reason.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-reason.ts#L39) ___ @@ -134,7 +134,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -144,7 +144,7 @@ ___ #### Defined in -[models/return-reason.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-reason.ts#L19) +[models/return-reason.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-reason.ts#L19) ## Methods @@ -158,4 +158,4 @@ ___ #### Defined in -[models/return-reason.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return-reason.ts#L44) +[models/return-reason.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return-reason.ts#L44) diff --git a/docs/content/references/entities/classes/SalesChannel.md b/docs/content/references/entities/classes/SalesChannel.md index d87c3a92eb..405a274a61 100644 --- a/docs/content/references/entities/classes/SalesChannel.md +++ b/docs/content/references/entities/classes/SalesChannel.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[models/sales-channel.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/sales-channel.ts#L13) +[models/sales-channel.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/sales-channel.ts#L13) ___ @@ -70,7 +70,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/sales-channel.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/sales-channel.ts#L16) +[models/sales-channel.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/sales-channel.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/sales-channel.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/sales-channel.ts#L10) +[models/sales-channel.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/sales-channel.ts#L10) ___ @@ -104,7 +104,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -118,4 +118,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/sales-channel.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/sales-channel.ts#L18) +[models/sales-channel.ts:18](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/sales-channel.ts#L18) diff --git a/docs/content/references/entities/classes/ShippingMethod.md b/docs/content/references/entities/classes/ShippingMethod.md index 1ff037bd2a..c2cc4638d9 100644 --- a/docs/content/references/entities/classes/ShippingMethod.md +++ b/docs/content/references/entities/classes/ShippingMethod.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-method.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L61) +[models/shipping-method.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L61) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/shipping-method.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L57) +[models/shipping-method.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L57) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/shipping-method.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L53) +[models/shipping-method.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L53) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/shipping-method.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L49) +[models/shipping-method.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L49) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L92) +[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L92) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/shipping-method.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L33) +[models/shipping-method.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L33) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/shipping-method.ts:95](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L95) +[models/shipping-method.ts:95](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L95) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[models/shipping-method.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L45) +[models/shipping-method.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L45) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[models/shipping-method.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L41) +[models/shipping-method.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L41) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[models/shipping-method.ts:89](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L89) +[models/shipping-method.ts:89](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L89) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[models/shipping-method.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L73) +[models/shipping-method.ts:73](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L73) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[models/shipping-method.ts:77](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L77) +[models/shipping-method.ts:77](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L77) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[models/shipping-method.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L81) +[models/shipping-method.ts:81](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L81) ___ @@ -148,7 +148,17 @@ ___ #### Defined in -[models/shipping-method.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L37) +[models/shipping-method.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L37) + +___ + +### subtotal + +• `Optional` **subtotal**: `number` + +#### Defined in + +[models/shipping-method.ts:97](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L97) ___ @@ -158,7 +168,7 @@ ___ #### Defined in -[models/shipping-method.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L69) +[models/shipping-method.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L69) ___ @@ -168,7 +178,7 @@ ___ #### Defined in -[models/shipping-method.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L65) +[models/shipping-method.ts:65](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L65) ___ @@ -178,7 +188,27 @@ ___ #### Defined in -[models/shipping-method.ts:86](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L86) +[models/shipping-method.ts:86](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L86) + +___ + +### tax\_total + +• `Optional` **tax\_total**: `number` + +#### Defined in + +[models/shipping-method.ts:99](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L99) + +___ + +### total + +• `Optional` **total**: `number` + +#### Defined in + +[models/shipping-method.ts:98](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L98) ## Methods @@ -192,4 +222,4 @@ ___ #### Defined in -[models/shipping-method.ts:97](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method.ts#L97) +[models/shipping-method.ts:101](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method.ts#L101) diff --git a/docs/content/references/entities/classes/ShippingMethodTaxLine.md b/docs/content/references/entities/classes/ShippingMethodTaxLine.md index 026d7dffc4..9bbf0fea5b 100644 --- a/docs/content/references/entities/classes/ShippingMethodTaxLine.md +++ b/docs/content/references/entities/classes/ShippingMethodTaxLine.md @@ -32,7 +32,7 @@ TaxLine.code #### Defined in -[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L13) +[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-line.ts#L13) ___ @@ -46,7 +46,7 @@ TaxLine.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -60,7 +60,7 @@ TaxLine.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -74,7 +74,7 @@ TaxLine.metadata #### Defined in -[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L16) +[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-line.ts#L16) ___ @@ -88,7 +88,7 @@ TaxLine.name #### Defined in -[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L10) +[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-line.ts#L10) ___ @@ -102,7 +102,7 @@ TaxLine.rate #### Defined in -[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L7) +[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-line.ts#L7) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[models/shipping-method-tax-line.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method-tax-line.ts#L24) +[models/shipping-method-tax-line.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method-tax-line.ts#L24) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[models/shipping-method-tax-line.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method-tax-line.ts#L20) +[models/shipping-method-tax-line.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method-tax-line.ts#L20) ___ @@ -136,7 +136,7 @@ TaxLine.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -150,4 +150,4 @@ TaxLine.updated\_at #### Defined in -[models/shipping-method-tax-line.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-method-tax-line.ts#L26) +[models/shipping-method-tax-line.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-method-tax-line.ts#L26) diff --git a/docs/content/references/entities/classes/ShippingOption.md b/docs/content/references/entities/classes/ShippingOption.md index 6482ad7a22..389062c0ea 100644 --- a/docs/content/references/entities/classes/ShippingOption.md +++ b/docs/content/references/entities/classes/ShippingOption.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/shipping-option.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L67) +[models/shipping-option.ts:67](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L67) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/shipping-option.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L61) +[models/shipping-option.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L61) ___ @@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/shipping-option.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L75) +[models/shipping-option.ts:75](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L75) ___ @@ -76,7 +76,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/shipping-option.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L81) +[models/shipping-option.ts:81](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L81) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L64) +[models/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L64) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/shipping-option.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L78) +[models/shipping-option.ts:78](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L78) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L31) +[models/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L31) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[models/shipping-option.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L58) +[models/shipping-option.ts:58](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L58) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[models/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L47) +[models/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L47) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L43) +[models/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L43) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L55) +[models/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L55) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/shipping-option.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L51) +[models/shipping-option.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L51) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L39) +[models/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L39) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/shipping-option.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L35) +[models/shipping-option.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L35) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/shipping-option.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L72) +[models/shipping-option.ts:72](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L72) ___ @@ -224,7 +224,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -238,4 +238,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/shipping-option.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L83) +[models/shipping-option.ts:83](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L83) diff --git a/docs/content/references/entities/classes/ShippingOptionRequirement.md b/docs/content/references/entities/classes/ShippingOptionRequirement.md index ed77d69b28..70af04df89 100644 --- a/docs/content/references/entities/classes/ShippingOptionRequirement.md +++ b/docs/content/references/entities/classes/ShippingOptionRequirement.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-option-requirement.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L38) +[models/shipping-option-requirement.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L38) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L41) +[models/shipping-option-requirement.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L41) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L24) +[models/shipping-option-requirement.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L24) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L32) +[models/shipping-option-requirement.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L32) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L28) +[models/shipping-option-requirement.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L28) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L35) +[models/shipping-option-requirement.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L35) ## Methods @@ -82,4 +82,4 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L43) +[models/shipping-option-requirement.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L43) diff --git a/docs/content/references/entities/classes/ShippingProfile.md b/docs/content/references/entities/classes/ShippingProfile.md index ba954ce701..2a39b7075d 100644 --- a/docs/content/references/entities/classes/ShippingProfile.md +++ b/docs/content/references/entities/classes/ShippingProfile.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -60,7 +60,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -70,7 +70,7 @@ ___ #### Defined in -[models/shipping-profile.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L30) +[models/shipping-profile.ts:30](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L30) ___ @@ -80,7 +80,7 @@ ___ #### Defined in -[models/shipping-profile.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L18) +[models/shipping-profile.ts:18](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L18) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/shipping-profile.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L24) +[models/shipping-profile.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L24) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/shipping-profile.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L27) +[models/shipping-profile.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L27) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/shipping-profile.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L21) +[models/shipping-profile.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L21) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -138,4 +138,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/shipping-profile.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L32) +[models/shipping-profile.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L32) diff --git a/docs/content/references/entities/classes/ShippingTaxRate.md b/docs/content/references/entities/classes/ShippingTaxRate.md index 31504bcc6e..007bdb1a7e 100644 --- a/docs/content/references/entities/classes/ShippingTaxRate.md +++ b/docs/content/references/entities/classes/ShippingTaxRate.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-tax-rate.ts#L31) +[models/shipping-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-tax-rate.ts#L31) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-tax-rate.ts#L37) +[models/shipping-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-tax-rate.ts#L37) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-tax-rate.ts#L20) +[models/shipping-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-tax-rate.ts#L20) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-tax-rate.ts#L24) +[models/shipping-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-tax-rate.ts#L24) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-tax-rate.ts#L17) +[models/shipping-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-tax-rate.ts#L17) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-tax-rate.ts#L28) +[models/shipping-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-tax-rate.ts#L28) ___ @@ -78,4 +78,4 @@ ___ #### Defined in -[models/shipping-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-tax-rate.ts#L34) +[models/shipping-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-tax-rate.ts#L34) diff --git a/docs/content/references/entities/classes/StagedJob.md b/docs/content/references/entities/classes/StagedJob.md index 8c06dca0c1..025ad132b7 100644 --- a/docs/content/references/entities/classes/StagedJob.md +++ b/docs/content/references/entities/classes/StagedJob.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/staged-job.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/staged-job.ts#L15) +[models/staged-job.ts:15](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/staged-job.ts#L15) ___ @@ -28,7 +28,7 @@ ___ #### Defined in -[models/staged-job.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/staged-job.ts#L12) +[models/staged-job.ts:12](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/staged-job.ts#L12) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/staged-job.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/staged-job.ts#L9) +[models/staged-job.ts:9](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/staged-job.ts#L9) ## Methods @@ -52,4 +52,4 @@ ___ #### Defined in -[models/staged-job.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/staged-job.ts#L17) +[models/staged-job.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/staged-job.ts#L17) diff --git a/docs/content/references/entities/classes/Store.md b/docs/content/references/entities/classes/Store.md index b3c27e2926..66755a5c56 100644 --- a/docs/content/references/entities/classes/Store.md +++ b/docs/content/references/entities/classes/Store.md @@ -32,7 +32,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/store.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L46) +[models/store.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L46) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/store.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L32) +[models/store.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L32) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/store.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L28) +[models/store.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L28) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/store.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L67) +[models/store.ts:67](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L67) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/store.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L61) +[models/store.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L61) ___ @@ -96,7 +96,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/store.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L55) +[models/store.ts:55](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L55) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/store.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L58) +[models/store.ts:58](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L58) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/store.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L25) +[models/store.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L25) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/store.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L52) +[models/store.ts:52](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L52) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/store.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L49) +[models/store.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L49) ___ @@ -160,7 +160,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -174,4 +174,4 @@ BaseEntity.updated\_at #### Defined in -[models/store.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/store.ts#L69) +[models/store.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/store.ts#L69) diff --git a/docs/content/references/entities/classes/Swap.md b/docs/content/references/entities/classes/Swap.md index fd5c90690f..148e99f0f6 100644 --- a/docs/content/references/entities/classes/Swap.md +++ b/docs/content/references/entities/classes/Swap.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/swap.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L62) +[models/swap.ts:62](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L62) ___ @@ -38,7 +38,7 @@ ___ #### Defined in -[models/swap.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L107) +[models/swap.ts:107](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L107) ___ @@ -48,7 +48,7 @@ ___ #### Defined in -[models/swap.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L101) +[models/swap.ts:101](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L101) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[models/swap.ts:95](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L95) +[models/swap.ts:95](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L95) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[models/swap.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L91) +[models/swap.ts:91](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L91) ___ @@ -78,7 +78,7 @@ ___ #### Defined in -[models/swap.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L98) +[models/swap.ts:98](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L98) ___ @@ -92,7 +92,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -106,7 +106,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/swap.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L76) +[models/swap.ts:76](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L76) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/swap.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L48) +[models/swap.ts:48](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L48) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/swap.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L70) +[models/swap.ts:70](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L70) ___ @@ -150,7 +150,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[models/swap.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L110) +[models/swap.ts:110](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L110) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[models/swap.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L113) +[models/swap.ts:113](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L113) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[models/swap.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L104) +[models/swap.ts:104](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L104) ___ @@ -190,7 +190,7 @@ ___ #### Defined in -[models/swap.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L59) +[models/swap.ts:59](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L59) ___ @@ -200,7 +200,7 @@ ___ #### Defined in -[models/swap.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L55) +[models/swap.ts:55](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L55) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[models/swap.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L73) +[models/swap.ts:73](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L73) ___ @@ -220,7 +220,7 @@ ___ #### Defined in -[models/swap.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L51) +[models/swap.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L51) ___ @@ -230,7 +230,7 @@ ___ #### Defined in -[models/swap.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L65) +[models/swap.ts:65](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L65) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[models/swap.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L83) +[models/swap.ts:83](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L83) ___ @@ -250,7 +250,7 @@ ___ #### Defined in -[models/swap.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L79) +[models/swap.ts:79](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L79) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[models/swap.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L88) +[models/swap.ts:88](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L88) ___ @@ -274,7 +274,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -288,4 +288,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/swap.ts:115](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L115) +[models/swap.ts:115](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L115) diff --git a/docs/content/references/entities/classes/TaxProvider.md b/docs/content/references/entities/classes/TaxProvider.md index 129560bb05..c1d892bc2a 100644 --- a/docs/content/references/entities/classes/TaxProvider.md +++ b/docs/content/references/entities/classes/TaxProvider.md @@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/tax-provider.ts:6](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-provider.ts#L6) +[models/tax-provider.ts:6](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-provider.ts#L6) ___ @@ -28,4 +28,4 @@ ___ #### Defined in -[models/tax-provider.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-provider.ts#L9) +[models/tax-provider.ts:9](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-provider.ts#L9) diff --git a/docs/content/references/entities/classes/TaxRate.md b/docs/content/references/entities/classes/TaxRate.md index 55b94f511d..8f65fd24cc 100644 --- a/docs/content/references/entities/classes/TaxRate.md +++ b/docs/content/references/entities/classes/TaxRate.md @@ -28,7 +28,7 @@ BaseEntity.constructor #### Defined in -[models/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L25) +[models/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L25) ___ @@ -42,7 +42,7 @@ BaseEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ BaseEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/tax-rate.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L38) +[models/tax-rate.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L38) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L28) +[models/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L28) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[models/tax-rate.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L83) +[models/tax-rate.ts:83](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L83) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[models/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L84) +[models/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L84) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[models/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L66) +[models/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L66) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[models/tax-rate.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L52) +[models/tax-rate.ts:52](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L52) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[models/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L22) +[models/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L22) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[models/tax-rate.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L35) +[models/tax-rate.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L35) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[models/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L31) +[models/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L31) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[models/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L85) +[models/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L85) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[models/tax-rate.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L80) +[models/tax-rate.ts:80](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L80) ___ @@ -180,7 +180,7 @@ BaseEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -194,4 +194,4 @@ BaseEntity.updated\_at #### Defined in -[models/tax-rate.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-rate.ts#L87) +[models/tax-rate.ts:87](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tax-rate.ts#L87) diff --git a/docs/content/references/entities/classes/TrackingLink.md b/docs/content/references/entities/classes/TrackingLink.md index 00723c00fc..a52634dc36 100644 --- a/docs/content/references/entities/classes/TrackingLink.md +++ b/docs/content/references/entities/classes/TrackingLink.md @@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[models/tracking-link.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tracking-link.ts#L21) +[models/tracking-link.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tracking-link.ts#L21) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/tracking-link.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tracking-link.ts#L17) +[models/tracking-link.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tracking-link.ts#L17) ___ @@ -80,7 +80,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[models/tracking-link.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tracking-link.ts#L24) +[models/tracking-link.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tracking-link.ts#L24) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/tracking-link.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tracking-link.ts#L27) +[models/tracking-link.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tracking-link.ts#L27) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/tracking-link.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tracking-link.ts#L14) +[models/tracking-link.ts:14](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tracking-link.ts#L14) ___ @@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[models/tracking-link.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tracking-link.ts#L11) +[models/tracking-link.ts:11](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tracking-link.ts#L11) ## Methods @@ -148,4 +148,4 @@ ___ #### Defined in -[models/tracking-link.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tracking-link.ts#L29) +[models/tracking-link.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/tracking-link.ts#L29) diff --git a/docs/content/references/entities/classes/User.md b/docs/content/references/entities/classes/User.md index 5d46545f08..234ff76034 100644 --- a/docs/content/references/entities/classes/User.md +++ b/docs/content/references/entities/classes/User.md @@ -28,7 +28,7 @@ SoftDeletableEntity.constructor #### Defined in -[models/user.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L37) +[models/user.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L37) ___ @@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at #### Defined in -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16) +[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L16) ___ @@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at #### Defined in -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) +[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[models/user.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L25) +[models/user.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L25) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[models/user.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L28) +[models/user.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L28) ___ @@ -90,7 +90,7 @@ SoftDeletableEntity.id #### Defined in -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13) +[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L13) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[models/user.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L31) +[models/user.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L31) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[models/user.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L40) +[models/user.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L40) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[models/user.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L34) +[models/user.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L34) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[models/user.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L21) +[models/user.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L21) ___ @@ -144,7 +144,7 @@ SoftDeletableEntity.updated\_at #### Defined in -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19) +[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/interfaces/models/base-entity.ts#L19) ## Methods @@ -158,4 +158,4 @@ SoftDeletableEntity.updated\_at #### Defined in -[models/user.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L42) +[models/user.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L42) diff --git a/docs/content/references/entities/enums/AllocationType.md b/docs/content/references/entities/enums/AllocationType.md index 410b56d7f1..6e6580d53d 100644 --- a/docs/content/references/entities/enums/AllocationType.md +++ b/docs/content/references/entities/enums/AllocationType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L16) +[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L16) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L15) +[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L15) diff --git a/docs/content/references/entities/enums/CartType.md b/docs/content/references/entities/enums/CartType.md index 2db3217674..5520f2c44c 100644 --- a/docs/content/references/entities/enums/CartType.md +++ b/docs/content/references/entities/enums/CartType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/cart.ts:208](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L208) +[models/cart.ts:208](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L208) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/cart.ts:204](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L204) +[models/cart.ts:204](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L204) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/cart.ts:206](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L206) +[models/cart.ts:206](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L206) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/cart.ts:207](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L207) +[models/cart.ts:207](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L207) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/cart.ts:205](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L205) +[models/cart.ts:205](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/cart.ts#L205) diff --git a/docs/content/references/entities/enums/ClaimFulfillmentStatus.md b/docs/content/references/entities/enums/ClaimFulfillmentStatus.md index 3c4d2afbfd..2874ada1ea 100644 --- a/docs/content/references/entities/enums/ClaimFulfillmentStatus.md +++ b/docs/content/references/entities/enums/ClaimFulfillmentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L45) +[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L45) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L40) +[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L40) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/claim-order.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L38) +[models/claim-order.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L38) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/claim-order.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L39) +[models/claim-order.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L39) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/claim-order.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L43) +[models/claim-order.ts:43](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L43) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/claim-order.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L41) +[models/claim-order.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L41) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/claim-order.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L46) +[models/claim-order.ts:46](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L46) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L44) +[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L44) ___ @@ -92,4 +92,4 @@ ___ #### Defined in -[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L42) +[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L42) diff --git a/docs/content/references/entities/enums/ClaimPaymentStatus.md b/docs/content/references/entities/enums/ClaimPaymentStatus.md index c197724d4f..d8f3a40be2 100644 --- a/docs/content/references/entities/enums/ClaimPaymentStatus.md +++ b/docs/content/references/entities/enums/ClaimPaymentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L32) +[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L32) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/claim-order.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L33) +[models/claim-order.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L33) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L34) +[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L34) diff --git a/docs/content/references/entities/enums/ClaimReason.md b/docs/content/references/entities/enums/ClaimReason.md index 25af6fad3b..288e5bc1da 100644 --- a/docs/content/references/entities/enums/ClaimReason.md +++ b/docs/content/references/entities/enums/ClaimReason.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/claim-item.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L23) +[models/claim-item.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L23) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L26) +[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L26) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/claim-item.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L25) +[models/claim-item.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L25) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[models/claim-item.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L24) +[models/claim-item.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-item.ts#L24) diff --git a/docs/content/references/entities/enums/ClaimType.md b/docs/content/references/entities/enums/ClaimType.md index f58205e8c3..f196223bb7 100644 --- a/docs/content/references/entities/enums/ClaimType.md +++ b/docs/content/references/entities/enums/ClaimType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L27) +[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L27) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L28) +[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/claim-order.ts#L28) diff --git a/docs/content/references/entities/enums/DiscountConditionOperator.md b/docs/content/references/entities/enums/DiscountConditionOperator.md index 719c345ab6..69fddf8a2b 100644 --- a/docs/content/references/entities/enums/DiscountConditionOperator.md +++ b/docs/content/references/entities/enums/DiscountConditionOperator.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L32) +[models/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L32) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/discount-condition.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L33) +[models/discount-condition.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L33) diff --git a/docs/content/references/entities/enums/DiscountConditionType.md b/docs/content/references/entities/enums/DiscountConditionType.md index e5cdf886b3..b442bc7e80 100644 --- a/docs/content/references/entities/enums/DiscountConditionType.md +++ b/docs/content/references/entities/enums/DiscountConditionType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L28) +[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L28) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/discount-condition.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L24) +[models/discount-condition.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L24) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L26) +[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L26) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L27) +[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L27) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/discount-condition.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L25) +[models/discount-condition.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-condition.ts#L25) diff --git a/docs/content/references/entities/enums/DiscountRuleType.md b/docs/content/references/entities/enums/DiscountRuleType.md index 3401a0eef7..7b01fecb50 100644 --- a/docs/content/references/entities/enums/DiscountRuleType.md +++ b/docs/content/references/entities/enums/DiscountRuleType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L9) +[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L9) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/discount-rule.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L11) +[models/discount-rule.ts:11](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L11) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L10) +[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/discount-rule.ts#L10) diff --git a/docs/content/references/entities/enums/DraftOrderStatus.md b/docs/content/references/entities/enums/DraftOrderStatus.md index a12ab36568..6b91bab9f5 100644 --- a/docs/content/references/entities/enums/DraftOrderStatus.md +++ b/docs/content/references/entities/enums/DraftOrderStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/draft-order.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L24) +[models/draft-order.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L24) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L23) +[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/draft-order.ts#L23) diff --git a/docs/content/references/entities/enums/FulfillmentStatus.md b/docs/content/references/entities/enums/FulfillmentStatus.md index 1045dc5862..39852af7a1 100644 --- a/docs/content/references/entities/enums/FulfillmentStatus.md +++ b/docs/content/references/entities/enums/FulfillmentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/order.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L64) +[models/order.ts:64](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L64) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/order.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L59) +[models/order.ts:59](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L59) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/order.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L57) +[models/order.ts:57](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L57) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/order.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L58) +[models/order.ts:58](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L58) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/order.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L62) +[models/order.ts:62](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L62) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/order.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L60) +[models/order.ts:60](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L60) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/order.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L65) +[models/order.ts:65](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L65) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/order.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L63) +[models/order.ts:63](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L63) ___ @@ -92,4 +92,4 @@ ___ #### Defined in -[models/order.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L61) +[models/order.ts:61](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L61) diff --git a/docs/content/references/entities/enums/OrderEditItemChangeType.md b/docs/content/references/entities/enums/OrderEditItemChangeType.md index 46fdb93adb..8c6b5c25fa 100644 --- a/docs/content/references/entities/enums/OrderEditItemChangeType.md +++ b/docs/content/references/entities/enums/OrderEditItemChangeType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/order-item-change.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L19) +[models/order-item-change.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L19) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/order-item-change.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L20) +[models/order-item-change.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L20) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/order-item-change.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order-item-change.ts#L21) +[models/order-item-change.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-item-change.ts#L21) diff --git a/docs/content/references/entities/enums/OrderEditStatus.md b/docs/content/references/entities/enums/OrderEditStatus.md new file mode 100644 index 0000000000..5fcd7ae418 --- /dev/null +++ b/docs/content/references/entities/enums/OrderEditStatus.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: OrderEditStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/order-edit.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L25) + +___ + +### CONFIRMED + +• **CONFIRMED** = ``"confirmed"`` + +#### Defined in + +[models/order-edit.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L21) + +___ + +### CREATED + +• **CREATED** = ``"created"`` + +#### Defined in + +[models/order-edit.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L24) + +___ + +### DECLINED + +• **DECLINED** = ``"declined"`` + +#### Defined in + +[models/order-edit.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L22) + +___ + +### REQUESTED + +• **REQUESTED** = ``"requested"`` + +#### Defined in + +[models/order-edit.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order-edit.ts#L23) diff --git a/docs/content/references/entities/enums/OrderStatus.md b/docs/content/references/entities/enums/OrderStatus.md index 2c387527d2..7db8163e65 100644 --- a/docs/content/references/entities/enums/OrderStatus.md +++ b/docs/content/references/entities/enums/OrderStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/order.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L51) +[models/order.ts:51](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L51) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/order.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L52) +[models/order.ts:52](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L52) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/order.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L50) +[models/order.ts:50](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L50) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/order.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L49) +[models/order.ts:49](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L49) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/order.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L53) +[models/order.ts:53](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L53) diff --git a/docs/content/references/entities/enums/PaymentCollectionStatus.md b/docs/content/references/entities/enums/PaymentCollectionStatus.md new file mode 100644 index 0000000000..cdfe6304d4 --- /dev/null +++ b/docs/content/references/entities/enums/PaymentCollectionStatus.md @@ -0,0 +1,105 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: PaymentCollectionStatus + +## Enumeration Members + +### AUTHORIZED + +• **AUTHORIZED** = ``"authorized"`` + +#### Defined in + +[models/payment-collection.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L22) + +___ + +### AWAITING + +• **AWAITING** = ``"awaiting"`` + +#### Defined in + +[models/payment-collection.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L21) + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +[models/payment-collection.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L28) + +___ + +### CAPTURED + +• **CAPTURED** = ``"captured"`` + +#### Defined in + +[models/payment-collection.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L24) + +___ + +### NOT\_PAID + +• **NOT\_PAID** = ``"not_paid"`` + +#### Defined in + +[models/payment-collection.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L20) + +___ + +### PARTIALLY\_AUTHORIZED + +• **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"`` + +#### Defined in + +[models/payment-collection.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L23) + +___ + +### PARTIALLY\_CAPTURED + +• **PARTIALLY\_CAPTURED** = ``"partially_captured"`` + +#### Defined in + +[models/payment-collection.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L25) + +___ + +### PARTIALLY\_REFUNDED + +• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` + +#### Defined in + +[models/payment-collection.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L27) + +___ + +### REFUNDED + +• **REFUNDED** = ``"refunded"`` + +#### Defined in + +[models/payment-collection.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L26) + +___ + +### REQUIRES\_ACTION + +• **REQUIRES\_ACTION** = ``"requires_action"`` + +#### Defined in + +[models/payment-collection.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L29) diff --git a/docs/content/references/entities/enums/PaymentCollectionType.md b/docs/content/references/entities/enums/PaymentCollectionType.md new file mode 100644 index 0000000000..d2a3d18d12 --- /dev/null +++ b/docs/content/references/entities/enums/PaymentCollectionType.md @@ -0,0 +1,15 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +# Enumeration: PaymentCollectionType + +## Enumeration Members + +### ORDER\_EDIT + +• **ORDER\_EDIT** = ``"order_edit"`` + +#### Defined in + +[models/payment-collection.ts:33](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-collection.ts#L33) diff --git a/docs/content/references/entities/enums/PaymentSessionStatus.md b/docs/content/references/entities/enums/PaymentSessionStatus.md index 249240e2e8..9fb78d3e5a 100644 --- a/docs/content/references/entities/enums/PaymentSessionStatus.md +++ b/docs/content/references/entities/enums/PaymentSessionStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/payment-session.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L17) +[models/payment-session.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L19) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L21) +[models/payment-session.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L23) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L20) +[models/payment-session.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L22) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/payment-session.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L18) +[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L20) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/payment-session.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/payment-session.ts#L19) +[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/payment-session.ts#L21) diff --git a/docs/content/references/entities/enums/PaymentStatus.md b/docs/content/references/entities/enums/PaymentStatus.md index 18fa5f93ca..93c9be1f32 100644 --- a/docs/content/references/entities/enums/PaymentStatus.md +++ b/docs/content/references/entities/enums/PaymentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/order.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L70) +[models/order.ts:70](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L70) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/order.ts:74](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L74) +[models/order.ts:74](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L74) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/order.ts:71](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L71) +[models/order.ts:71](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L71) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/order.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L69) +[models/order.ts:69](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L69) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/order.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L72) +[models/order.ts:72](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L72) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/order.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L73) +[models/order.ts:73](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L73) ___ @@ -72,4 +72,4 @@ ___ #### Defined in -[models/order.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/order.ts#L75) +[models/order.ts:75](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/order.ts#L75) diff --git a/docs/content/references/entities/enums/ProductStatus.md b/docs/content/references/entities/enums/ProductStatus.md index 5266caaa5f..62a78fb223 100644 --- a/docs/content/references/entities/enums/ProductStatus.md +++ b/docs/content/references/entities/enums/ProductStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/product.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L28) +[models/product.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L28) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/product.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L29) +[models/product.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L29) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/product.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L30) +[models/product.ts:30](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L30) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[models/product.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/product.ts#L31) +[models/product.ts:31](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/product.ts#L31) diff --git a/docs/content/references/entities/enums/RefundReason.md b/docs/content/references/entities/enums/RefundReason.md index 525212dc1c..a276267616 100644 --- a/docs/content/references/entities/enums/RefundReason.md +++ b/docs/content/references/entities/enums/RefundReason.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/refund.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L19) +[models/refund.ts:19](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L19) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/refund.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L16) +[models/refund.ts:16](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L16) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/refund.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L20) +[models/refund.ts:20](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L20) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/refund.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L17) +[models/refund.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L17) ___ @@ -52,4 +52,4 @@ ___ #### Defined in -[models/refund.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/refund.ts#L18) +[models/refund.ts:18](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/refund.ts#L18) diff --git a/docs/content/references/entities/enums/RequirementType.md b/docs/content/references/entities/enums/RequirementType.md index c5d4863af4..0d8e2a3d99 100644 --- a/docs/content/references/entities/enums/RequirementType.md +++ b/docs/content/references/entities/enums/RequirementType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-option-requirement.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L18) +[models/shipping-option-requirement.ts:18](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L18) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/shipping-option-requirement.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option-requirement.ts#L17) +[models/shipping-option-requirement.ts:17](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option-requirement.ts#L17) diff --git a/docs/content/references/entities/enums/ReturnStatus.md b/docs/content/references/entities/enums/ReturnStatus.md index ee765b5f75..8f08ea45ad 100644 --- a/docs/content/references/entities/enums/ReturnStatus.md +++ b/docs/content/references/entities/enums/ReturnStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/return.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L25) +[models/return.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L25) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/return.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L23) +[models/return.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L23) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/return.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L22) +[models/return.ts:22](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L22) ___ @@ -42,4 +42,4 @@ ___ #### Defined in -[models/return.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/return.ts#L24) +[models/return.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/return.ts#L24) diff --git a/docs/content/references/entities/enums/ShippingOptionPriceType.md b/docs/content/references/entities/enums/ShippingOptionPriceType.md index 2b2268c4c9..435b5ad701 100644 --- a/docs/content/references/entities/enums/ShippingOptionPriceType.md +++ b/docs/content/references/entities/enums/ShippingOptionPriceType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-option.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L24) +[models/shipping-option.ts:24](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L24) ___ @@ -22,4 +22,4 @@ ___ #### Defined in -[models/shipping-option.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-option.ts#L23) +[models/shipping-option.ts:23](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-option.ts#L23) diff --git a/docs/content/references/entities/enums/ShippingProfileType.md b/docs/content/references/entities/enums/ShippingProfileType.md index a595a0f24f..f6ac3882e0 100644 --- a/docs/content/references/entities/enums/ShippingProfileType.md +++ b/docs/content/references/entities/enums/ShippingProfileType.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/shipping-profile.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L12) +[models/shipping-profile.ts:12](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L12) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/shipping-profile.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L10) +[models/shipping-profile.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L10) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/shipping-profile.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/shipping-profile.ts#L11) +[models/shipping-profile.ts:11](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/shipping-profile.ts#L11) diff --git a/docs/content/references/entities/enums/SwapFulfillmentStatus.md b/docs/content/references/entities/enums/SwapFulfillmentStatus.md index 4938b311ff..69af2dc274 100644 --- a/docs/content/references/entities/enums/SwapFulfillmentStatus.md +++ b/docs/content/references/entities/enums/SwapFulfillmentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/swap.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L29) +[models/swap.ts:29](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L29) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/swap.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L26) +[models/swap.ts:26](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L26) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/swap.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L25) +[models/swap.ts:25](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L25) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/swap.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L28) +[models/swap.ts:28](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L28) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/swap.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L30) +[models/swap.ts:30](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L30) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[models/swap.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L27) +[models/swap.ts:27](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L27) diff --git a/docs/content/references/entities/enums/SwapPaymentStatus.md b/docs/content/references/entities/enums/SwapPaymentStatus.md index 1952202178..3612777773 100644 --- a/docs/content/references/entities/enums/SwapPaymentStatus.md +++ b/docs/content/references/entities/enums/SwapPaymentStatus.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/swap.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L35) +[models/swap.ts:35](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L35) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/swap.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L38) +[models/swap.ts:38](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L38) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[models/swap.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L36) +[models/swap.ts:36](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L36) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[models/swap.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L37) +[models/swap.ts:37](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L37) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[models/swap.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L39) +[models/swap.ts:39](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L39) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[models/swap.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L34) +[models/swap.ts:34](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L34) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[models/swap.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L40) +[models/swap.ts:40](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L40) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[models/swap.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L41) +[models/swap.ts:41](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L41) ___ @@ -92,4 +92,4 @@ ___ #### Defined in -[models/swap.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/swap.ts#L42) +[models/swap.ts:42](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/swap.ts#L42) diff --git a/docs/content/references/entities/enums/UserRoles.md b/docs/content/references/entities/enums/UserRoles.md index 3ea3bb2aab..d6395e2006 100644 --- a/docs/content/references/entities/enums/UserRoles.md +++ b/docs/content/references/entities/enums/UserRoles.md @@ -12,7 +12,7 @@ displayed_sidebar: entitiesSidebar #### Defined in -[models/user.ts:8](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L8) +[models/user.ts:8](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L8) ___ @@ -22,7 +22,7 @@ ___ #### Defined in -[models/user.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L10) +[models/user.ts:10](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L10) ___ @@ -32,4 +32,4 @@ ___ #### Defined in -[models/user.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/user.ts#L9) +[models/user.ts:9](https://github.com/medusajs/medusa/blob/c4c83c971/packages/medusa/src/models/user.ts#L9) diff --git a/docs/content/references/entities/index.md b/docs/content/references/entities/index.md index 91a44b3d5f..d672cb187b 100644 --- a/docs/content/references/entities/index.md +++ b/docs/content/references/entities/index.md @@ -18,7 +18,10 @@ displayed_sidebar: entitiesSidebar - [DraftOrderStatus](enums/DraftOrderStatus.md) - [FulfillmentStatus](enums/FulfillmentStatus.md) - [OrderEditItemChangeType](enums/OrderEditItemChangeType.md) +- [OrderEditStatus](enums/OrderEditStatus.md) - [OrderStatus](enums/OrderStatus.md) +- [PaymentCollectionStatus](enums/PaymentCollectionStatus.md) +- [PaymentCollectionType](enums/PaymentCollectionType.md) - [PaymentSessionStatus](enums/PaymentSessionStatus.md) - [PaymentStatus](enums/PaymentStatus.md) - [ProductStatus](enums/ProductStatus.md) @@ -73,6 +76,7 @@ displayed_sidebar: entitiesSidebar - [OrderEdit](classes/OrderEdit.md) - [OrderItemChange](classes/OrderItemChange.md) - [Payment](classes/Payment.md) +- [PaymentCollection](classes/PaymentCollection.md) - [PaymentProvider](classes/PaymentProvider.md) - [PaymentSession](classes/PaymentSession.md) - [PriceList](classes/PriceList.md) diff --git a/docs/content/references/js-client/classes/AddressesResource.md b/docs/content/references/js-client/classes/AddressesResource.md index cf0f300249..ce0db48ace 100644 --- a/docs/content/references/js-client/classes/AddressesResource.md +++ b/docs/content/references/js-client/classes/AddressesResource.md @@ -27,7 +27,7 @@ Adds an address to a customers saved addresses #### Defined in -[medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/addresses.ts#L16) +[medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/addresses.ts#L16) ___ @@ -50,7 +50,7 @@ Deletes an address of a customer #### Defined in -[medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/addresses.ts#L30) +[medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/addresses.ts#L30) ___ @@ -74,4 +74,4 @@ Update an address of a customer #### Defined in -[medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/addresses.ts#L45) +[medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/addresses.ts#L45) diff --git a/docs/content/references/js-client/classes/Admin.md b/docs/content/references/js-client/classes/Admin.md index 6fd19b72c0..83e1d58bb4 100644 --- a/docs/content/references/js-client/classes/Admin.md +++ b/docs/content/references/js-client/classes/Admin.md @@ -14,7 +14,7 @@ #### Defined in -[medusa-js/src/resources/admin/index.ts:32](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L32) +[medusa-js/src/resources/admin/index.ts:34](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L34) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:33](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L33) +[medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L35) ___ @@ -34,7 +34,17 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L37) +[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L40) + +___ + +### currencies + +• **currencies**: [`AdminCurrenciesResource`](AdminCurrenciesResource.md) + +#### Defined in + +[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L39) ___ @@ -44,7 +54,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L35) +[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L37) ___ @@ -54,7 +64,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:34](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L34) +[medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L36) ___ @@ -64,7 +74,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L36) +[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L38) ___ @@ -74,7 +84,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L38) +[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L41) ___ @@ -84,7 +94,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L39) +[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L42) ___ @@ -94,7 +104,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L40) +[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L43) ___ @@ -104,7 +114,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L41) +[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L44) ___ @@ -114,7 +124,17 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L57) +[medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L61) + +___ + +### orderEdits + +• **orderEdits**: [`AdminOrderEditsResource`](AdminOrderEditsResource.md) + +#### Defined in + +[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L52) ___ @@ -124,7 +144,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L48) +[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L51) ___ @@ -134,7 +154,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L42) +[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L45) ___ @@ -144,7 +164,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L44) +[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L47) ___ @@ -154,7 +174,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L45) +[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L48) ___ @@ -164,7 +184,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L43) +[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L46) ___ @@ -174,7 +194,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L56) +[medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L60) ___ @@ -184,7 +204,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L49) +[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L53) ___ @@ -194,7 +214,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L47) +[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L50) ___ @@ -204,7 +224,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L51) +[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L55) ___ @@ -214,7 +234,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L55) +[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L59) ___ @@ -224,7 +244,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L53) +[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L57) ___ @@ -234,7 +254,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L54) +[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L58) ___ @@ -244,7 +264,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L52) +[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L56) ___ @@ -254,7 +274,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L58) +[medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L62) ___ @@ -264,7 +284,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L59) +[medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L63) ___ @@ -274,7 +294,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L46) +[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L49) ___ @@ -284,4 +304,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/index.ts#L50) +[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/index.ts#L54) diff --git a/docs/content/references/js-client/classes/AdminAuthResource.md b/docs/content/references/js-client/classes/AdminAuthResource.md index 8d31b42bf0..3e71fd2a05 100644 --- a/docs/content/references/js-client/classes/AdminAuthResource.md +++ b/docs/content/references/js-client/classes/AdminAuthResource.md @@ -29,7 +29,7 @@ Creates an authenticated session #### Defined in -[medusa-js/src/resources/admin/auth.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/auth.ts#L37) +[medusa-js/src/resources/admin/auth.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/auth.ts#L37) ___ @@ -53,7 +53,7 @@ destroys an authenticated session #### Defined in -[medusa-js/src/resources/admin/auth.ts:24](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/auth.ts#L24) +[medusa-js/src/resources/admin/auth.ts:24](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/auth.ts#L24) ___ @@ -78,4 +78,4 @@ Usually used to check if authenticated session is alive. #### Defined in -[medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/auth.ts#L12) +[medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/auth.ts#L12) diff --git a/docs/content/references/js-client/classes/AdminBatchJobsResource.md b/docs/content/references/js-client/classes/AdminBatchJobsResource.md index aea4de52c1..8f12de19cc 100644 --- a/docs/content/references/js-client/classes/AdminBatchJobsResource.md +++ b/docs/content/references/js-client/classes/AdminBatchJobsResource.md @@ -25,7 +25,7 @@ #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:35](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/batch-jobs.ts#L35) +[medusa-js/src/resources/admin/batch-jobs.ts:35](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/batch-jobs.ts#L35) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:43](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/batch-jobs.ts#L43) +[medusa-js/src/resources/admin/batch-jobs.ts:43](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/batch-jobs.ts#L43) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:13](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/batch-jobs.ts#L13) +[medusa-js/src/resources/admin/batch-jobs.ts:13](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/batch-jobs.ts#L13) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:21](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/batch-jobs.ts#L21) +[medusa-js/src/resources/admin/batch-jobs.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/batch-jobs.ts#L21) ___ @@ -109,4 +109,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:51](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/batch-jobs.ts#L51) +[medusa-js/src/resources/admin/batch-jobs.ts:51](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/batch-jobs.ts#L51) diff --git a/docs/content/references/js-client/classes/AdminCollectionsResource.md b/docs/content/references/js-client/classes/AdminCollectionsResource.md index e3d98c150a..b6c76eed83 100644 --- a/docs/content/references/js-client/classes/AdminCollectionsResource.md +++ b/docs/content/references/js-client/classes/AdminCollectionsResource.md @@ -30,7 +30,7 @@ Updates products associated with a Product Collection #### Defined in -[medusa-js/src/resources/admin/collections.ts:100](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/collections.ts#L100) +[medusa-js/src/resources/admin/collections.ts:100](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/collections.ts#L100) ___ @@ -57,7 +57,7 @@ Created collection. #### Defined in -[medusa-js/src/resources/admin/collections.ts:22](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/collections.ts#L22) +[medusa-js/src/resources/admin/collections.ts:22](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/collections.ts#L22) ___ @@ -84,7 +84,7 @@ Deleted response #### Defined in -[medusa-js/src/resources/admin/collections.ts:52](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/collections.ts#L52) +[medusa-js/src/resources/admin/collections.ts:52](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/collections.ts#L52) ___ @@ -111,7 +111,7 @@ a list of collections matching the query. #### Defined in -[medusa-js/src/resources/admin/collections.ts:80](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/collections.ts#L80) +[medusa-js/src/resources/admin/collections.ts:80](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/collections.ts#L80) ___ @@ -137,7 +137,7 @@ Removes products associated with a Product Collection #### Defined in -[medusa-js/src/resources/admin/collections.ts:115](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/collections.ts#L115) +[medusa-js/src/resources/admin/collections.ts:115](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/collections.ts#L115) ___ @@ -164,7 +164,7 @@ the collection with the given id #### Defined in -[medusa-js/src/resources/admin/collections.ts:66](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/collections.ts#L66) +[medusa-js/src/resources/admin/collections.ts:66](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/collections.ts#L66) ___ @@ -192,4 +192,4 @@ the updated collection. #### Defined in -[medusa-js/src/resources/admin/collections.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/collections.ts#L37) +[medusa-js/src/resources/admin/collections.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/collections.ts#L37) diff --git a/docs/content/references/js-client/classes/AdminCurrenciesResource.md b/docs/content/references/js-client/classes/AdminCurrenciesResource.md new file mode 100644 index 0000000000..95b3410c70 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminCurrenciesResource.md @@ -0,0 +1,66 @@ +# Class: AdminCurrenciesResource + +## Hierarchy + +- `default` + + ↳ **`AdminCurrenciesResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\> + +**`Description`** + +Lists currencies. + This feature is under development and may change in the future. +To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\> + +the list of currencies as well as the pagination properties. + +#### Defined in + +[medusa-js/src/resources/admin/currencies.ts:20](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/currencies.ts#L20) + +___ + +### update + +▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> + +**`Description`** + +Updates a currency + This feature is under development and may change in the future. +To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | code of the currency to update. | +| `payload` | [`AdminPostCurrenciesCurrencyReq`](internal-4.AdminPostCurrenciesCurrencyReq.md) | update to apply to currency. | +| `customHeaders` | `Record`<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> + +the updated currency. + +#### Defined in + +[medusa-js/src/resources/admin/currencies.ts:43](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/currencies.ts#L43) diff --git a/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md b/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md index ef2d0c33fe..114fe83d10 100644 --- a/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md +++ b/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md @@ -10,7 +10,7 @@ ### addCustomers -▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> Add multiple customers to a customer group. @@ -19,22 +19,22 @@ Add multiple customers to a customer group. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group | +| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customer-groups.ts#L112) +[medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customer-groups.ts#L112) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> Create a customer group. @@ -42,16 +42,16 @@ Create a customer group. | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminPostCustomerGroupsReq`](internal-4.AdminPostCustomerGroupsReq.md) | customer group info | +| `payload` | [`AdminPostCustomerGroupsReq`](internal-5.AdminPostCustomerGroupsReq.md) | customer group info | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customer-groups.ts#L26) +[medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customer-groups.ts#L26) ___ @@ -74,13 +74,13 @@ Deletes a customer group. #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customer-groups.ts#L77) +[medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customer-groups.ts#L77) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-4.md#admincustomergroupslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-5.md#admincustomergroupslistres)\> Lists customer groups. @@ -88,22 +88,22 @@ Lists customer groups. | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetCustomerGroupsParams`](internal-4.AdminGetCustomerGroupsParams.md) | optional | +| `query?` | [`AdminGetCustomerGroupsParams`](internal-5.AdminGetCustomerGroupsParams.md) | optional | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-4.md#admincustomergroupslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-5.md#admincustomergroupslistres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customer-groups.ts#L91) +[medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customer-groups.ts#L91) ___ ### listCustomers -▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-4.md#admincustomerslistres)\> +▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> List and count customers that belong to provided customer groups. @@ -112,22 +112,22 @@ List and count customers that belong to provided customer groups. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `query?` | [`AdminGetCustomersParams`](internal-4.AdminGetCustomersParams.md) | params for filtering customers | +| `query?` | [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) | params for filtering customers | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-4.md#admincustomerslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customer-groups.ts#L144) +[medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customer-groups.ts#L144) ___ ### removeCustomers -▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> Remove multiple customers from a customer group. @@ -136,22 +136,22 @@ Remove multiple customers from a customer group. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group | +| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customer-groups.ts#L128) +[medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customer-groups.ts#L128) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> Retrieves a customer group. @@ -160,22 +160,22 @@ Retrieves a customer group. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-4.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. | +| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-5.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customer-groups.ts#L41) +[medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customer-groups.ts#L41) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> Updates a customer group @@ -184,13 +184,13 @@ Updates a customer group | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-4.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with | +| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-5.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customer-groups.ts#L62) +[medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customer-groups.ts#L62) diff --git a/docs/content/references/js-client/classes/AdminCustomersResource.md b/docs/content/references/js-client/classes/AdminCustomersResource.md index d7419d5b06..f2dce643b0 100644 --- a/docs/content/references/js-client/classes/AdminCustomersResource.md +++ b/docs/content/references/js-client/classes/AdminCustomersResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> Creates a customer @@ -18,22 +18,22 @@ Creates a customer | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminPostCustomersReq`](internal-5.AdminPostCustomersReq.md) | information of customer | +| `payload` | [`AdminPostCustomersReq`](internal-6.AdminPostCustomersReq.md) | information of customer | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> #### Defined in -[medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customers.ts#L18) +[medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customers.ts#L18) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-4.md#admincustomerslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> Lists customers @@ -41,22 +41,22 @@ Lists customers | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetCustomersParams`](internal-4.AdminGetCustomersParams.md) | optional | +| `query?` | [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) | optional | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-4.md#admincustomerslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> #### Defined in -[medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customers.ts#L59) +[medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customers.ts#L59) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> Retrieves a customer @@ -69,17 +69,17 @@ Retrieves a customer #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> #### Defined in -[medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customers.ts#L46) +[medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customers.ts#L46) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> Updates a customer @@ -88,13 +88,13 @@ Updates a customer | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer id | -| `payload` | [`AdminPostCustomersCustomerReq`](internal-5.AdminPostCustomersCustomerReq.md) | data to update customer with | +| `payload` | [`AdminPostCustomersCustomerReq`](internal-6.AdminPostCustomersCustomerReq.md) | data to update customer with | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> #### Defined in -[medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/customers.ts#L32) +[medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/customers.ts#L32) diff --git a/docs/content/references/js-client/classes/AdminDiscountsResource.md b/docs/content/references/js-client/classes/AdminDiscountsResource.md index 8949dea414..7492171719 100644 --- a/docs/content/references/js-client/classes/AdminDiscountsResource.md +++ b/docs/content/references/js-client/classes/AdminDiscountsResource.md @@ -10,7 +10,7 @@ ### addRegion -▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -26,17 +26,17 @@ Adds region to discount #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:24](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L24) +[medusa-js/src/resources/admin/discounts.ts:24](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L24) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -46,22 +46,22 @@ Creates discounts | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostDiscountsReq`](internal-6.AdminPostDiscountsReq.md) | +| `payload` | [`AdminPostDiscountsReq`](internal-7.AdminPostDiscountsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L36) +[medusa-js/src/resources/admin/discounts.ts:36](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L36) ___ ### createCondition -▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -72,23 +72,23 @@ creates a discount condition | Name | Type | | :------ | :------ | | `discountId` | `string` | -| `payload` | [`AdminPostDiscountsDiscountConditions`](internal-6.AdminPostDiscountsDiscountConditions.md) | -| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal-6.AdminPostDiscountsDiscountConditionsParams.md) | +| `payload` | [`AdminPostDiscountsDiscountConditions`](internal-7.AdminPostDiscountsDiscountConditions.md) | +| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal-7.AdminPostDiscountsDiscountConditionsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:145](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L145) +[medusa-js/src/resources/admin/discounts.ts:145](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L145) ___ ### createDynamicCode -▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -99,16 +99,16 @@ Creates a dynamic discount code | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md) | +| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:59](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L59) +[medusa-js/src/resources/admin/discounts.ts:59](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L59) ___ @@ -133,7 +133,7 @@ Deletes a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:71](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L71) +[medusa-js/src/resources/admin/discounts.ts:71](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L71) ___ @@ -159,13 +159,13 @@ Removes a condition from a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:184](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L184) +[medusa-js/src/resources/admin/discounts.ts:184](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L184) ___ ### deleteDynamicCode -▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -181,17 +181,17 @@ Deletes a dynamic discount #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:82](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L82) +[medusa-js/src/resources/admin/discounts.ts:82](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L82) ___ ### getCondition -▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-6.md#admindiscountconditionsres)\> +▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-7.md#admindiscountconditionsres)\> **`Description`** @@ -203,22 +203,22 @@ Gets a condition from a discount | :------ | :------ | | `discountId` | `string` | | `conditionId` | `string` | -| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md) | +| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-6.md#admindiscountconditionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-7.md#admindiscountconditionsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:196](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L196) +[medusa-js/src/resources/admin/discounts.ts:196](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L196) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-6.md#admindiscountslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-7.md#admindiscountslistres)\> **`Description`** @@ -228,22 +228,22 @@ Lists discounts | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetDiscountsParams`](internal-6.AdminGetDiscountsParams.md) | +| `query?` | [`AdminGetDiscountsParams`](internal-7.AdminGetDiscountsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-6.md#admindiscountslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-7.md#admindiscountslistres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:116](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L116) +[medusa-js/src/resources/admin/discounts.ts:116](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L116) ___ ### removeRegion -▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -259,17 +259,17 @@ Removes a region from a discount #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:133](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L133) +[medusa-js/src/resources/admin/discounts.ts:133](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L133) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -284,17 +284,17 @@ Retrieves a discount #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:94](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L94) +[medusa-js/src/resources/admin/discounts.ts:94](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L94) ___ ### retrieveByCode -▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -309,17 +309,17 @@ Retrieves a discount by code #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:105](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L105) +[medusa-js/src/resources/admin/discounts.ts:105](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L105) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -330,22 +330,22 @@ Updates discount | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostDiscountsDiscountReq`](internal-6.AdminPostDiscountsDiscountReq.md) | +| `payload` | [`AdminPostDiscountsDiscountReq`](internal-7.AdminPostDiscountsDiscountReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:47](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L47) +[medusa-js/src/resources/admin/discounts.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L47) ___ ### updateCondition -▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> **`Description`** @@ -357,14 +357,14 @@ Updates a discount condition | :------ | :------ | | `discountId` | `string` | | `conditionId` | `string` | -| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-6.AdminPostDiscountsDiscountConditionsCondition.md) | -| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md) | +| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-7.AdminPostDiscountsDiscountConditionsCondition.md) | +| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> #### Defined in -[medusa-js/src/resources/admin/discounts.ts:164](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/discounts.ts#L164) +[medusa-js/src/resources/admin/discounts.ts:164](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/discounts.ts#L164) diff --git a/docs/content/references/js-client/classes/AdminDraftOrdersResource.md b/docs/content/references/js-client/classes/AdminDraftOrdersResource.md index 94993a909b..66010747f5 100644 --- a/docs/content/references/js-client/classes/AdminDraftOrdersResource.md +++ b/docs/content/references/js-client/classes/AdminDraftOrdersResource.md @@ -10,7 +10,7 @@ ### addLineItem -▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> **`Description`** @@ -21,22 +21,22 @@ Add line item to draft order | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md) | +| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:30](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L30) +[medusa-js/src/resources/admin/draft-orders.ts:30](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L30) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> **`Description`** @@ -46,16 +46,16 @@ Creates a draft order | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-7.AdminPostDraftOrdersDraftOrderReq.md) | +| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.AdminPostDraftOrdersDraftOrderReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:19](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L19) +[medusa-js/src/resources/admin/draft-orders.ts:19](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L19) ___ @@ -80,13 +80,13 @@ Delete draft order #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:42](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L42) +[medusa-js/src/resources/admin/draft-orders.ts:42](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L42) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-7.md#admindraftorderslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.md#admindraftorderslistres)\> **`Description`** @@ -96,22 +96,22 @@ Lists draft orders | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetDraftOrdersParams`](internal-7.AdminGetDraftOrdersParams.md) | +| `query?` | [`AdminGetDraftOrdersParams`](internal-8.AdminGetDraftOrdersParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-7.md#admindraftorderslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.md#admindraftorderslistres)\> #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:76](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L76) +[medusa-js/src/resources/admin/draft-orders.ts:76](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L76) ___ ### markPaid -▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-7.md#adminpostdraftordersdraftorderregisterpaymentres)\> +▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.md#adminpostdraftordersdraftorderregisterpaymentres)\> **`Description`** @@ -126,17 +126,17 @@ Mark a draft order as paid #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-7.md#adminpostdraftordersdraftorderregisterpaymentres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.md#adminpostdraftordersdraftorderregisterpaymentres)\> #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:93](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L93) +[medusa-js/src/resources/admin/draft-orders.ts:93](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L93) ___ ### removeLineItem -▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> **`Description`** @@ -152,17 +152,17 @@ Remove line item #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:53](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L53) +[medusa-js/src/resources/admin/draft-orders.ts:53](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L53) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> **`Description`** @@ -177,17 +177,17 @@ Retrieves a draft order #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:65](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L65) +[medusa-js/src/resources/admin/draft-orders.ts:65](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L65) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> **`Description`** @@ -198,22 +198,22 @@ Update draft order | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-7.AdminPostDraftOrdersDraftOrderReq.md) | +| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.AdminPostDraftOrdersDraftOrderReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:104](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L104) +[medusa-js/src/resources/admin/draft-orders.ts:104](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L104) ___ ### updateLineItem -▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> **`Description`** @@ -225,13 +225,13 @@ Update draft order line item | :------ | :------ | | `id` | `string` | | `itemId` | `string` | -| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) | +| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:116](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/draft-orders.ts#L116) +[medusa-js/src/resources/admin/draft-orders.ts:116](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/draft-orders.ts#L116) diff --git a/docs/content/references/js-client/classes/AdminGiftCardsResource.md b/docs/content/references/js-client/classes/AdminGiftCardsResource.md index e163de293e..b6160b74b9 100644 --- a/docs/content/references/js-client/classes/AdminGiftCardsResource.md +++ b/docs/content/references/js-client/classes/AdminGiftCardsResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> **`Description`** @@ -20,16 +20,16 @@ Creates a gift card | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostGiftCardsReq`](internal-8.AdminPostGiftCardsReq.md) | +| `payload` | [`AdminPostGiftCardsReq`](internal-9.AdminPostGiftCardsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/gift-cards.ts#L17) +[medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/gift-cards.ts#L17) ___ @@ -54,13 +54,13 @@ Deletes a gift card #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/gift-cards.ts#L40) +[medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/gift-cards.ts#L40) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.md#admingiftcardslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-9.md#admingiftcardslistres)\> **`Description`** @@ -70,22 +70,22 @@ Lists gift cards | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetGiftCardsParams`](internal-8.AdminGetGiftCardsParams.md) | +| `query?` | [`AdminGetGiftCardsParams`](internal-9.AdminGetGiftCardsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.md#admingiftcardslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-9.md#admingiftcardslistres)\> #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/gift-cards.ts#L62) +[medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/gift-cards.ts#L62) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> **`Description`** @@ -100,17 +100,17 @@ Deletes a gift card #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/gift-cards.ts#L51) +[medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/gift-cards.ts#L51) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> **`Description`** @@ -121,13 +121,13 @@ Updates a gift card | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-8.AdminPostGiftCardsGiftCardReq.md) | +| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-9.AdminPostGiftCardsGiftCardReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/gift-cards.ts#L28) +[medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/gift-cards.ts#L28) diff --git a/docs/content/references/js-client/classes/AdminInvitesResource.md b/docs/content/references/js-client/classes/AdminInvitesResource.md index 8b539644b5..1f13e858cf 100644 --- a/docs/content/references/js-client/classes/AdminInvitesResource.md +++ b/docs/content/references/js-client/classes/AdminInvitesResource.md @@ -16,7 +16,7 @@ | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-9.AdminPostInvitesInviteAcceptReq.md) | +| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-10.AdminPostInvitesInviteAcceptReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns @@ -25,7 +25,7 @@ #### Defined in -[medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/invites.ts#L10) +[medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/invites.ts#L10) ___ @@ -37,7 +37,7 @@ ___ | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostInvitesPayload`](../modules/internal-9.md#adminpostinvitespayload) | +| `payload` | [`AdminPostInvitesPayload`](../modules/internal-10.md#adminpostinvitespayload) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns @@ -46,7 +46,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/invites.ts#L18) +[medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/invites.ts#L18) ___ @@ -67,13 +67,13 @@ ___ #### Defined in -[medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/invites.ts#L26) +[medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/invites.ts#L26) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-9.md#adminlistinvitesres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-10.md#adminlistinvitesres)\> #### Parameters @@ -83,11 +83,11 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-9.md#adminlistinvitesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-10.md#adminlistinvitesres)\> #### Defined in -[medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/invites.ts#L34) +[medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/invites.ts#L34) ___ @@ -108,4 +108,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/invites.ts:41](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/invites.ts#L41) +[medusa-js/src/resources/admin/invites.ts:41](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/invites.ts#L41) diff --git a/docs/content/references/js-client/classes/AdminNotesResource.md b/docs/content/references/js-client/classes/AdminNotesResource.md index 2332edbeda..73c7cca9b9 100644 --- a/docs/content/references/js-client/classes/AdminNotesResource.md +++ b/docs/content/references/js-client/classes/AdminNotesResource.md @@ -10,22 +10,22 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostNotesReq`](internal-10.AdminPostNotesReq.md) | +| `payload` | [`AdminPostNotesReq`](internal-11.AdminPostNotesReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L14) +[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L14) ___ @@ -46,34 +46,34 @@ ___ #### Defined in -[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L31) +[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L31) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-10.md#adminnoteslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-11.md#adminnoteslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetNotesParams`](internal-10.AdminGetNotesParams.md) | +| `query?` | [`AdminGetNotesParams`](internal-11.AdminGetNotesParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-10.md#adminnoteslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-11.md#adminnoteslistres)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L47) +[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L47) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> #### Parameters @@ -84,30 +84,30 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L39) +[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L39) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostNotesNoteReq`](internal-10.AdminPostNotesNoteReq.md) | +| `payload` | [`AdminPostNotesNoteReq`](internal-11.AdminPostNotesNoteReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notes.ts#L22) +[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notes.ts#L22) diff --git a/docs/content/references/js-client/classes/AdminNotificationsResource.md b/docs/content/references/js-client/classes/AdminNotificationsResource.md index 8503604391..5ce8022668 100644 --- a/docs/content/references/js-client/classes/AdminNotificationsResource.md +++ b/docs/content/references/js-client/classes/AdminNotificationsResource.md @@ -10,41 +10,41 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-11.md#adminnotificationslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-12.md#adminnotificationslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetNotificationsParams`](internal-11.AdminGetNotificationsParams.md) | +| `query?` | [`AdminGetNotificationsParams`](internal-12.AdminGetNotificationsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-11.md#adminnotificationslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-12.md#adminnotificationslistres)\> #### Defined in -[medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notifications.ts#L12) +[medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notifications.ts#L12) ___ ### resend -▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-11.md#adminnotificationsres)\> +▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-12.md#adminnotificationsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-11.AdminPostNotificationsNotificationResendReq.md) | +| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-12.AdminPostNotificationsNotificationResendReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-11.md#adminnotificationsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-12.md#adminnotificationsres)\> #### Defined in -[medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/notifications.ts#L26) +[medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/notifications.ts#L26) diff --git a/docs/content/references/js-client/classes/AdminOrderEditsResource.md b/docs/content/references/js-client/classes/AdminOrderEditsResource.md new file mode 100644 index 0000000000..399268c6a8 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminOrderEditsResource.md @@ -0,0 +1,244 @@ +# Class: AdminOrderEditsResource + +## Hierarchy + +- `default` + + ↳ **`AdminOrderEditsResource`** + +## Methods + +### addLineItem + +▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrderEditsEditLineItemsReq`](internal-13.AdminPostOrderEditsEditLineItemsReq.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L47) + +___ + +### cancel + +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:73](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L73) + +___ + +### confirm + +▸ **confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:81](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L81) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostOrderEditsReq`](internal-13.AdminPostOrderEditsReq.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:22](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L22) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L39) + +___ + +### deleteItemChange + +▸ **deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-13.md#adminorderedititemchangedeleteres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `itemChangeId` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-13.md#adminorderedititemchangedeleteres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:56](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L56) + +___ + +### removeLineItem + +▸ **removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `itemId` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:99](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L99) + +___ + +### requestConfirmation + +▸ **requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:65](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L65) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:14](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L14) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostOrderEditsOrderEditReq`](internal-13.AdminPostOrderEditsOrderEditReq.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:30](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L30) + +___ + +### updateLineItem + +▸ **updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `itemId` | `string` | +| `payload` | [`AdminPostOrderEditsEditLineItemsLineItemReq`](internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/admin/order-edits.ts:89](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/order-edits.ts#L89) diff --git a/docs/content/references/js-client/classes/AdminOrdersResource.md b/docs/content/references/js-client/classes/AdminOrdersResource.md index 33498ca3ca..c8da15e194 100644 --- a/docs/content/references/js-client/classes/AdminOrdersResource.md +++ b/docs/content/references/js-client/classes/AdminOrdersResource.md @@ -10,29 +10,29 @@ ### addShippingMethod -▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-12.AdminPostOrdersOrderShippingMethodsReq.md) | +| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-14.AdminPostOrdersOrderShippingMethodsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L144) +[medusa-js/src/resources/admin/orders.ts:152](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L152) ___ ### archive -▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -43,17 +43,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:153](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L153) +[medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L161) ___ ### cancel -▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -64,17 +64,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:136](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L136) +[medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L144) ___ ### cancelClaim -▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -86,17 +86,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:217](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L217) +[medusa-js/src/resources/admin/orders.ts:225](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L225) ___ ### cancelClaimFulfillment -▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -109,17 +109,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:108](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L108) +[medusa-js/src/resources/admin/orders.ts:116](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L116) ___ ### cancelFulfillment -▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -131,17 +131,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:89](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L89) +[medusa-js/src/resources/admin/orders.ts:97](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L97) ___ ### cancelSwap -▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -153,17 +153,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:170](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L170) +[medusa-js/src/resources/admin/orders.ts:178](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L178) ___ ### cancelSwapFulfillment -▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -176,17 +176,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:98](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L98) +[medusa-js/src/resources/admin/orders.ts:106](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L106) ___ ### capturePayment -▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -197,17 +197,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L63) +[medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L71) ___ ### complete -▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -218,39 +218,39 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:55](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L55) +[medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L63) ___ ### createClaim -▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-12.AdminPostOrdersOrderClaimsReq.md) | +| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-14.AdminPostOrdersOrderClaimsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:208](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L208) +[medusa-js/src/resources/admin/orders.ts:216](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L216) ___ ### createClaimShipment -▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -258,88 +258,88 @@ ___ | :------ | :------ | | `id` | `string` | | `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) | +| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:246](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L246) +[medusa-js/src/resources/admin/orders.ts:254](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L254) ___ ### createFulfillment -▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-12.AdminPostOrdersOrderFulfillmentsReq.md) | +| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-14.AdminPostOrdersOrderFulfillmentsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:80](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L80) +[medusa-js/src/resources/admin/orders.ts:88](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L88) ___ ### createShipment -▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-12.AdminPostOrdersOrderShipmentReq.md) | +| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-14.AdminPostOrdersOrderShipmentReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:118](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L118) +[medusa-js/src/resources/admin/orders.ts:126](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L126) ___ ### createSwap -▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-12.AdminPostOrdersOrderSwapsReq.md) | +| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-14.AdminPostOrdersOrderSwapsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L161) +[medusa-js/src/resources/admin/orders.ts:169](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L169) ___ ### createSwapShipment -▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -347,22 +347,22 @@ ___ | :------ | :------ | | `id` | `string` | | `swapId` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) | +| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:189](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L189) +[medusa-js/src/resources/admin/orders.ts:197](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L197) ___ ### fulfillClaim -▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -370,22 +370,22 @@ ___ | :------ | :------ | | `id` | `string` | | `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) | +| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:236](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L236) +[medusa-js/src/resources/admin/orders.ts:244](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L244) ___ ### fulfillSwap -▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -393,43 +393,43 @@ ___ | :------ | :------ | | `id` | `string` | | `swapId` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) | +| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:179](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L179) +[medusa-js/src/resources/admin/orders.ts:187](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L187) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-12.md#adminorderslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-14.md#adminorderslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetOrdersParams`](internal-12.AdminGetOrdersParams.md) | +| `query?` | [`AdminGetOrdersParams`](internal-14.AdminGetOrdersParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-12.md#adminorderslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-14.md#adminorderslistres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:41](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L41) +[medusa-js/src/resources/admin/orders.ts:49](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L49) ___ ### processSwapPayment -▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -441,104 +441,105 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:199](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L199) +[medusa-js/src/resources/admin/orders.ts:207](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L207) ___ ### refundPayment -▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-12.AdminPostOrdersOrderRefundsReq.md) | +| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-14.AdminPostOrdersOrderRefundsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L71) +[medusa-js/src/resources/admin/orders.ts:79](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L79) ___ ### requestReturn -▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-12.AdminPostOrdersOrderReturnsReq.md) | +| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-14.AdminPostOrdersOrderReturnsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:127](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L127) +[medusa-js/src/resources/admin/orders.ts:135](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L135) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | +| `query?` | [`FindParams`](internal-5.FindParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:33](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L33) +[medusa-js/src/resources/admin/orders.ts:34](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L34) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderReq`](internal-12.AdminPostOrdersOrderReq.md) | +| `payload` | [`AdminPostOrdersOrderReq`](internal-14.AdminPostOrdersOrderReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:24](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L24) +[medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L25) ___ ### updateClaim -▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Parameters @@ -546,13 +547,13 @@ ___ | :------ | :------ | | `id` | `string` | | `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-12.AdminPostOrdersOrderClaimsClaimReq.md) | +| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-14.AdminPostOrdersOrderClaimsClaimReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:226](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/orders.ts#L226) +[medusa-js/src/resources/admin/orders.ts:234](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/orders.ts#L234) diff --git a/docs/content/references/js-client/classes/AdminPriceListResource.md b/docs/content/references/js-client/classes/AdminPriceListResource.md index 12748592b5..edbab077d5 100644 --- a/docs/content/references/js-client/classes/AdminPriceListResource.md +++ b/docs/content/references/js-client/classes/AdminPriceListResource.md @@ -10,44 +10,44 @@ ### addPrices -▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\> +▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-13.AdminPostPriceListPricesPricesReq.md) | +| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-15.AdminPostPriceListPricesPricesReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L80) +[medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L80) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostPriceListsPriceListReq`](internal-13.AdminPostPriceListsPriceListReq.md) | +| `payload` | [`AdminPostPriceListsPriceListReq`](internal-15.AdminPostPriceListsPriceListReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L18) +[medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L18) ___ @@ -68,35 +68,35 @@ ___ #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:35](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L35) +[medusa-js/src/resources/admin/price-lists.ts:35](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L35) ___ ### deletePrices -▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\> +▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-13.AdminDeletePriceListPricesPricesReq.md) | +| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-15.AdminDeletePriceListPricesPricesReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L89) +[medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L89) ___ ### deleteProductPrices -▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\> +▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> #### Parameters @@ -108,17 +108,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L98) +[medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L98) ___ ### deleteVariantPrices -▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\> +▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> #### Parameters @@ -130,32 +130,32 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L107) +[medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L107) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-13.md#adminpricelistslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-15.md#adminpricelistslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetPriceListPaginationParams`](internal-13.AdminGetPriceListPaginationParams.md) | +| `query?` | [`AdminGetPriceListPaginationParams`](internal-15.AdminGetPriceListPaginationParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-13.md#adminpricelistslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-15.md#adminpricelistslistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L51) +[medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L51) ___ @@ -168,7 +168,7 @@ ___ | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-13.AdminGetPriceListsPriceListProductsParams.md) | +| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-15.AdminGetPriceListsPriceListProductsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns @@ -177,13 +177,13 @@ ___ #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:65](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L65) +[medusa-js/src/resources/admin/price-lists.ts:65](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L65) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> #### Parameters @@ -194,30 +194,30 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L43) +[medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L43) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-13.AdminPostPriceListsPriceListPriceListReq.md) | +| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-15.AdminPostPriceListsPriceListPriceListReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/price-lists.ts#L26) +[medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/price-lists.ts#L26) diff --git a/docs/content/references/js-client/classes/AdminProductTagsResource.md b/docs/content/references/js-client/classes/AdminProductTagsResource.md index 18215d58ff..e69cabbe6e 100644 --- a/docs/content/references/js-client/classes/AdminProductTagsResource.md +++ b/docs/content/references/js-client/classes/AdminProductTagsResource.md @@ -10,18 +10,18 @@ ### list -▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-14.md#adminproducttagslistres)\> +▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-16.md#adminproducttagslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductTagsParams`](internal-14.AdminGetProductTagsParams.md) | +| `query?` | [`AdminGetProductTagsParams`](internal-16.AdminGetProductTagsParams.md) | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-14.md#adminproducttagslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-16.md#adminproducttagslistres)\> #### Defined in -[medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/product-tags.ts#L10) +[medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/product-tags.ts#L10) diff --git a/docs/content/references/js-client/classes/AdminProductTypesResource.md b/docs/content/references/js-client/classes/AdminProductTypesResource.md index 59df9c4ca5..e16b4569c0 100644 --- a/docs/content/references/js-client/classes/AdminProductTypesResource.md +++ b/docs/content/references/js-client/classes/AdminProductTypesResource.md @@ -10,18 +10,18 @@ ### list -▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-15.md#adminproducttypeslistres)\> +▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-17.md#adminproducttypeslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductTypesParams`](internal-15.AdminGetProductTypesParams.md) | +| `query?` | [`AdminGetProductTypesParams`](internal-17.AdminGetProductTypesParams.md) | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-15.md#adminproducttypeslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-17.md#adminproducttypeslistres)\> #### Defined in -[medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/product-types.ts#L10) +[medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/product-types.ts#L10) diff --git a/docs/content/references/js-client/classes/AdminProductsResource.md b/docs/content/references/js-client/classes/AdminProductsResource.md index 5fdc6dd4e0..3a0d5cd419 100644 --- a/docs/content/references/js-client/classes/AdminProductsResource.md +++ b/docs/content/references/js-client/classes/AdminProductsResource.md @@ -10,72 +10,72 @@ ### addOption -▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductOptionsReq`](internal-16.AdminPostProductsProductOptionsReq.md) | +| `payload` | [`AdminPostProductsProductOptionsReq`](internal-18.AdminPostProductsProductOptionsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:121](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L121) +[medusa-js/src/resources/admin/products.ts:121](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L121) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostProductsReq`](internal-16.AdminPostProductsReq.md) | +| `payload` | [`AdminPostProductsReq`](internal-18.AdminPostProductsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L23) +[medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L23) ___ ### createVariant -▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductVariantsReq`](internal-16.AdminPostProductsProductVariantsReq.md) | +| `payload` | [`AdminPostProductsProductVariantsReq`](internal-18.AdminPostProductsProductVariantsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:93](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L93) +[medusa-js/src/resources/admin/products.ts:93](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L93) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-16.md#adminproductsdeleteres)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-18.md#adminproductsdeleteres)\> #### Parameters @@ -86,17 +86,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-16.md#adminproductsdeleteres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-18.md#adminproductsdeleteres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L48) +[medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L48) ___ ### deleteOption -▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-16.md#adminproductsdeleteoptionres)\> +▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-18.md#adminproductsdeleteoptionres)\> #### Parameters @@ -108,17 +108,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-16.md#adminproductsdeleteoptionres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-18.md#adminproductsdeleteoptionres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:140](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L140) +[medusa-js/src/resources/admin/products.ts:140](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L140) ___ ### deleteVariant -▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-16.md#adminproductsdeletevariantres)\> +▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-18.md#adminproductsdeletevariantres)\> #### Parameters @@ -130,38 +130,38 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-16.md#adminproductsdeletevariantres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-18.md#adminproductsdeletevariantres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:112](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L112) +[medusa-js/src/resources/admin/products.ts:112](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L112) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-16.md#adminproductslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-18.md#adminproductslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductsParams`](internal-16.AdminGetProductsParams.md) | +| `query?` | [`AdminGetProductsParams`](internal-18.AdminGetProductsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-16.md#adminproductslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-18.md#adminproductslistres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L56) +[medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L56) ___ ### listTags -▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-16.md#adminproductslisttagsres)\> +▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-18.md#adminproductslisttagsres)\> #### Parameters @@ -171,17 +171,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-16.md#adminproductslisttagsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-18.md#adminproductslisttagsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:77](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L77) +[medusa-js/src/resources/admin/products.ts:77](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L77) ___ ### listTypes -▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-16.md#adminproductslisttypesres)\> +▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-18.md#adminproductslisttypesres)\> #### Parameters @@ -191,17 +191,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-16.md#adminproductslisttypesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-18.md#adminproductslisttypesres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:70](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L70) +[medusa-js/src/resources/admin/products.ts:70](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L70) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Parameters @@ -212,61 +212,61 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L31) +[medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L31) ___ ### setMetadata -▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductMetadataReq`](internal-16.AdminPostProductsProductMetadataReq.md) | +| `payload` | [`AdminPostProductsProductMetadataReq`](internal-18.AdminPostProductsProductMetadataReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:84](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L84) +[medusa-js/src/resources/admin/products.ts:84](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L84) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductReq`](internal-16.AdminPostProductsProductReq.md) | +| `payload` | [`AdminPostProductsProductReq`](internal-18.AdminPostProductsProductReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L39) +[medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L39) ___ ### updateOption -▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Parameters @@ -274,22 +274,22 @@ ___ | :------ | :------ | | `id` | `string` | | `optionId` | `string` | -| `payload` | [`AdminPostProductsProductOptionsOption`](internal-16.AdminPostProductsProductOptionsOption.md) | +| `payload` | [`AdminPostProductsProductOptionsOption`](internal-18.AdminPostProductsProductOptionsOption.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:130](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L130) +[medusa-js/src/resources/admin/products.ts:130](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L130) ___ ### updateVariant -▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Parameters @@ -297,13 +297,13 @@ ___ | :------ | :------ | | `id` | `string` | | `variantId` | `string` | -| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-16.AdminPostProductsProductVariantsVariantReq.md) | +| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-18.AdminPostProductsProductVariantsVariantReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:102](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/products.ts#L102) +[medusa-js/src/resources/admin/products.ts:102](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/products.ts#L102) diff --git a/docs/content/references/js-client/classes/AdminRegionsResource.md b/docs/content/references/js-client/classes/AdminRegionsResource.md index 195fe3e071..41a7a83c2c 100644 --- a/docs/content/references/js-client/classes/AdminRegionsResource.md +++ b/docs/content/references/js-client/classes/AdminRegionsResource.md @@ -10,7 +10,7 @@ ### addCountry -▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -21,24 +21,24 @@ adds a country to the list of countries in a region | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-17.AdminPostRegionsRegionCountriesReq.md) | country data | +| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-19.AdminPostRegionsRegionCountriesReq.md) | country data | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L103) +[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L103) ___ ### addFulfillmentProvider -▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -49,24 +49,24 @@ adds a fulfillment provider to a region | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data | +| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L135) +[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L135) ___ ### addPaymentProvider -▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -77,24 +77,24 @@ adds a payment provider to a region | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-17.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data | +| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-19.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L181) +[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L181) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -104,18 +104,18 @@ creates a region. | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostRegionsReq`](internal-17.AdminPostRegionsReq.md) | +| `payload` | [`AdminPostRegionsReq`](internal-19.AdminPostRegionsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> created region. #### Defined in -[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L24) +[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L24) ___ @@ -142,13 +142,13 @@ Deleted response #### Defined in -[medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L54) +[medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L54) ___ ### deleteCountry -▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -164,19 +164,19 @@ remove a country from a region's list of coutnries #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L119) +[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L119) ___ ### deleteFulfillmentProvider -▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -192,19 +192,19 @@ remove a fulfillment provider from a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L151) +[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L151) ___ ### deletePaymentProvider -▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -220,19 +220,19 @@ removes a payment provider from a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L197) +[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L197) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-17.md#adminregionslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-19.md#adminregionslistres)\> **`Description`** @@ -242,24 +242,24 @@ lists regions matching a query | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetRegionsParams`](internal-17.AdminGetRegionsParams.md) | query for searching regions | +| `query?` | [`AdminGetRegionsParams`](internal-19.AdminGetRegionsParams.md) | query for searching regions | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-17.md#adminregionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-19.md#adminregionslistres)\> a list of regions matching the query. #### Defined in -[medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L82) +[medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L82) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -274,19 +274,19 @@ get a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> the region with the given id #### Defined in -[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L68) +[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L68) ___ ### retrieveFulfillmentOptions -▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> +▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> **`Description`** @@ -301,19 +301,19 @@ retrieves the list of fulfillment options available in a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> list of fulfillment options #### Defined in -[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L166) +[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L166) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> **`Description`** @@ -324,15 +324,15 @@ updates a region | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the region to update. | -| `payload` | [`AdminPostRegionsRegionReq`](internal-17.AdminPostRegionsRegionReq.md) | update to apply to region. | +| `payload` | [`AdminPostRegionsRegionReq`](internal-19.AdminPostRegionsRegionReq.md) | update to apply to region. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> the updated region. #### Defined in -[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/regions.ts#L39) +[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/regions.ts#L39) diff --git a/docs/content/references/js-client/classes/AdminReturnReasonsResource.md b/docs/content/references/js-client/classes/AdminReturnReasonsResource.md index cbc00539af..3e4b823996 100644 --- a/docs/content/references/js-client/classes/AdminReturnReasonsResource.md +++ b/docs/content/references/js-client/classes/AdminReturnReasonsResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> **`Description`** @@ -20,18 +20,18 @@ Creates a return reason. | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostReturnReasonsReq`](internal-18.AdminPostReturnReasonsReq.md) | +| `payload` | [`AdminPostReturnReasonsReq`](internal-20.AdminPostReturnReasonsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> Created return reason. #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/return-reasons.ts#L18) +[medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/return-reasons.ts#L18) ___ @@ -58,13 +58,13 @@ Deleted response #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/return-reasons.ts#L48) +[medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/return-reasons.ts#L48) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-18.md#adminreturnreasonslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-20.md#adminreturnreasonslistres)\> **`Description`** @@ -78,19 +78,19 @@ Lists return reasons matching a query #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-18.md#adminreturnreasonslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-20.md#adminreturnreasonslistres)\> a list of return reasons matching the query. #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:75](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/return-reasons.ts#L75) +[medusa-js/src/resources/admin/return-reasons.ts:75](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/return-reasons.ts#L75) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> **`Description`** @@ -105,19 +105,19 @@ retrieves a return reason #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> the return reason with the given id #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:62](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/return-reasons.ts#L62) +[medusa-js/src/resources/admin/return-reasons.ts:62](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/return-reasons.ts#L62) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> **`Description`** @@ -128,15 +128,15 @@ Updates a return reason | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the return reason to update. | -| `payload` | [`AdminPostReturnReasonsReasonReq`](internal-18.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | +| `payload` | [`AdminPostReturnReasonsReasonReq`](internal-20.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> the updated return reason. #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/return-reasons.ts#L33) +[medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/return-reasons.ts#L33) diff --git a/docs/content/references/js-client/classes/AdminReturnsResource.md b/docs/content/references/js-client/classes/AdminReturnsResource.md index e06fd20262..25c6e5cec0 100644 --- a/docs/content/references/js-client/classes/AdminReturnsResource.md +++ b/docs/content/references/js-client/classes/AdminReturnsResource.md @@ -10,7 +10,7 @@ ### cancel -▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-19.md#adminreturnscancelres)\> +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-21.md#adminreturnscancelres)\> **`Description`** @@ -25,19 +25,19 @@ cancels a return #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-19.md#adminreturnscancelres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-21.md#adminreturnscancelres)\> the order for which the return was canceled #### Defined in -[medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/returns.ts#L19) +[medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/returns.ts#L19) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-19.md#adminreturnslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-21.md#adminreturnslistres)\> **`Description`** @@ -47,24 +47,24 @@ lists returns matching a query | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetReturnsParams`](internal-19.AdminGetReturnsParams.md) | query for searching returns | +| `query?` | [`AdminGetReturnsParams`](internal-21.AdminGetReturnsParams.md) | query for searching returns | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-19.md#adminreturnslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-21.md#adminreturnslistres)\> a list of returns matching the query #### Defined in -[medusa-js/src/resources/admin/returns.ts:49](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/returns.ts#L49) +[medusa-js/src/resources/admin/returns.ts:49](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/returns.ts#L49) ___ ### receive -▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-19.md#adminreturnsres)\> +▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-21.md#adminreturnsres)\> **`Description`** @@ -75,15 +75,15 @@ receive a return | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the return to receive. | -| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-19.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | +| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-21.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-19.md#adminreturnsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-21.md#adminreturnsres)\> the return #### Defined in -[medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/returns.ts#L34) +[medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/returns.ts#L34) diff --git a/docs/content/references/js-client/classes/AdminSalesChannelsResource.md b/docs/content/references/js-client/classes/AdminSalesChannelsResource.md index ae1c94bfc5..649698d95f 100644 --- a/docs/content/references/js-client/classes/AdminSalesChannelsResource.md +++ b/docs/content/references/js-client/classes/AdminSalesChannelsResource.md @@ -10,7 +10,7 @@ ### addProducts -▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> Add products to a sales channel This feature is under development and may change in the future. @@ -25,39 +25,39 @@ Add products to a sales channel | Name | Type | | :------ | :------ | | `salesChannelId` | `string` | -| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md) | +| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> a medusa sales channel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:116](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/sales-channels.ts#L116) +[medusa-js/src/resources/admin/sales-channels.ts:116](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/sales-channels.ts#L116) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostSalesChannelsReq`](internal-20.AdminPostSalesChannelsReq.md) | +| `payload` | [`AdminPostSalesChannelsReq`](internal-22.AdminPostSalesChannelsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:34](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/sales-channels.ts#L34) +[medusa-js/src/resources/admin/sales-channels.ts:34](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/sales-channels.ts#L34) ___ @@ -88,13 +88,13 @@ an deletion result #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:85](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/sales-channels.ts#L85) +[medusa-js/src/resources/admin/sales-channels.ts:85](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/sales-channels.ts#L85) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-20.md#adminsaleschannelslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-22.md#adminsaleschannelslistres)\> Retrieve a list of sales channels This feature is under development and may change in the future. @@ -108,24 +108,24 @@ Retrieve a list of sales channels | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetSalesChannelsParams`](internal-20.AdminGetSalesChannelsParams.md) | +| `query?` | [`AdminGetSalesChannelsParams`](internal-22.AdminGetSalesChannelsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-20.md#adminsaleschannelslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-22.md#adminsaleschannelslistres)\> the list of sales channel as well as the pagination properties #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:64](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/sales-channels.ts#L64) +[medusa-js/src/resources/admin/sales-channels.ts:64](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/sales-channels.ts#L64) ___ ### removeProducts -▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> Remove products from a sales channel This feature is under development and may change in the future. @@ -140,24 +140,24 @@ Remove products from a sales channel | Name | Type | | :------ | :------ | | `salesChannelId` | `string` | -| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md) | +| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> a medusa sales channel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:100](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/sales-channels.ts#L100) +[medusa-js/src/resources/admin/sales-channels.ts:100](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/sales-channels.ts#L100) ___ ### retrieve -▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> retrieve a sales channel This feature is under development and may change in the future. @@ -176,19 +176,19 @@ gets a sales channel #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> a medusa sales channel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:22](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/sales-channels.ts#L22) +[medusa-js/src/resources/admin/sales-channels.ts:22](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/sales-channels.ts#L22) ___ ### update -▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> update a sales channel This feature is under development and may change in the future. @@ -203,15 +203,15 @@ updates a sales channel | Name | Type | | :------ | :------ | | `salesChannelId` | `string` | -| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-20.AdminPostSalesChannelsSalesChannelReq.md) | +| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-22.AdminPostSalesChannelsSalesChannelReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> the updated medusa sales channel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:48](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/sales-channels.ts#L48) +[medusa-js/src/resources/admin/sales-channels.ts:48](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/sales-channels.ts#L48) diff --git a/docs/content/references/js-client/classes/AdminShippingOptionsResource.md b/docs/content/references/js-client/classes/AdminShippingOptionsResource.md index a617b34b42..ac1a324e03 100644 --- a/docs/content/references/js-client/classes/AdminShippingOptionsResource.md +++ b/docs/content/references/js-client/classes/AdminShippingOptionsResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> **`Description`** @@ -20,18 +20,18 @@ creates a shipping option. | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostShippingOptionsReq`](internal-21.AdminPostShippingOptionsReq.md) | +| `payload` | [`AdminPostShippingOptionsReq`](internal-23.AdminPostShippingOptionsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> created shipping option. #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-options.ts#L20) +[medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L20) ___ @@ -58,13 +58,13 @@ deleted response #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-options.ts#L50) +[medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L50) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-21.md#adminshippingoptionslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-23.md#adminshippingoptionslistres)\> **`Description`** @@ -74,24 +74,24 @@ lists shipping options matching a query | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetShippingOptionsParams`](internal-21.AdminGetShippingOptionsParams.md) | query for searching shipping options | +| `query?` | [`AdminGetShippingOptionsParams`](internal-23.AdminGetShippingOptionsParams.md) | query for searching shipping options | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-21.md#adminshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-23.md#adminshippingoptionslistres)\> a list of shipping options matching the query. #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-options.ts#L78) +[medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L78) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> **`Description`** @@ -106,19 +106,19 @@ get a shipping option #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> the shipping option with the given id #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-options.ts#L64) +[medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L64) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> **`Description`** @@ -129,15 +129,15 @@ updates a shipping option | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the shipping option to update. | -| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-21.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | +| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-23.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> the updated shipping option. #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-options.ts#L35) +[medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-options.ts#L35) diff --git a/docs/content/references/js-client/classes/AdminShippingProfilesResource.md b/docs/content/references/js-client/classes/AdminShippingProfilesResource.md index f22afda6e4..25b668cf18 100644 --- a/docs/content/references/js-client/classes/AdminShippingProfilesResource.md +++ b/docs/content/references/js-client/classes/AdminShippingProfilesResource.md @@ -10,22 +10,22 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostShippingProfilesReq`](internal-22.AdminPostShippingProfilesReq.md) | +| `payload` | [`AdminPostShippingProfilesReq`](internal-24.AdminPostShippingProfilesReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12) +[medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12) ___ @@ -46,13 +46,13 @@ ___ #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29) +[medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-22.md#adminshippingprofileslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-24.md#adminshippingprofileslistres)\> #### Parameters @@ -62,17 +62,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-22.md#adminshippingprofileslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-24.md#adminshippingprofileslistres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45) +[medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> #### Parameters @@ -83,30 +83,30 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37) +[medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-22.AdminPostShippingProfilesProfileReq.md) | +| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-24.AdminPostShippingProfilesProfileReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20) +[medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20) diff --git a/docs/content/references/js-client/classes/AdminStoresResource.md b/docs/content/references/js-client/classes/AdminStoresResource.md index ce153b2089..055a43e6e8 100644 --- a/docs/content/references/js-client/classes/AdminStoresResource.md +++ b/docs/content/references/js-client/classes/AdminStoresResource.md @@ -10,7 +10,7 @@ ### addCurrency -▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\> +▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> **`Description`** @@ -25,19 +25,19 @@ adds a currency to the store. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> updated store. #### Defined in -[medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/store.ts#L31) +[medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/store.ts#L31) ___ ### deleteCurrency -▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\> +▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> **`Description`** @@ -52,19 +52,19 @@ deletes a currency from the available store currencies #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> updated store #### Defined in -[medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/store.ts#L45) +[medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/store.ts#L45) ___ ### listPaymentProviders -▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-23.md#adminpaymentproviderslist)\> +▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-25.md#adminpaymentproviderslist)\> **`Description`** @@ -78,19 +78,19 @@ Lists the store's payment providers #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-23.md#adminpaymentproviderslist)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-25.md#adminpaymentproviderslist)\> a list of payment providers configured on the store #### Defined in -[medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/store.ts#L68) +[medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/store.ts#L68) ___ ### listTaxProviders -▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-23.md#admintaxproviderslist)\> +▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-25.md#admintaxproviderslist)\> **`Description`** @@ -104,19 +104,19 @@ Lists the store's payment providers #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-23.md#admintaxproviderslist)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-25.md#admintaxproviderslist)\> a list of payment providers configured on the store #### Defined in -[medusa-js/src/resources/admin/store.ts:79](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/store.ts#L79) +[medusa-js/src/resources/admin/store.ts:79](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/store.ts#L79) ___ ### retrieve -▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\> +▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> **`Description`** @@ -130,19 +130,19 @@ gets a medusa store #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> a medusa store #### Defined in -[medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/store.ts#L57) +[medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/store.ts#L57) ___ ### update -▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\> +▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> **`Description`** @@ -152,15 +152,15 @@ Updates the store | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminPostStoreReq`](internal-23.AdminPostStoreReq.md) | update to apply to the store. | +| `payload` | [`AdminPostStoreReq`](internal-25.AdminPostStoreReq.md) | update to apply to the store. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> the updated store. #### Defined in -[medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/store.ts#L17) +[medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/store.ts#L17) diff --git a/docs/content/references/js-client/classes/AdminSwapsResource.md b/docs/content/references/js-client/classes/AdminSwapsResource.md index f3249dc915..0f68279df4 100644 --- a/docs/content/references/js-client/classes/AdminSwapsResource.md +++ b/docs/content/references/js-client/classes/AdminSwapsResource.md @@ -10,28 +10,28 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-24.md#adminswapslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-26.md#adminswapslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetSwapsParams`](internal-24.AdminGetSwapsParams.md) | +| `query?` | [`AdminGetSwapsParams`](internal-26.AdminGetSwapsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-24.md#adminswapslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-26.md#adminswapslistres)\> #### Defined in -[medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/swaps.ts#L19) +[medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/swaps.ts#L19) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-24.md#adminswapsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-26.md#adminswapsres)\> #### Parameters @@ -42,8 +42,8 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-24.md#adminswapsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-26.md#adminswapsres)\> #### Defined in -[medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/swaps.ts#L11) +[medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/swaps.ts#L11) diff --git a/docs/content/references/js-client/classes/AdminTaxRatesResource.md b/docs/content/references/js-client/classes/AdminTaxRatesResource.md index 552ddc098a..17f286a8b7 100644 --- a/docs/content/references/js-client/classes/AdminTaxRatesResource.md +++ b/docs/content/references/js-client/classes/AdminTaxRatesResource.md @@ -10,92 +10,92 @@ ### addProductTypes -▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L100) +[medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L100) ___ ### addProducts -▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-25.AdminPostTaxRatesTaxRateProductsReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-27.AdminPostTaxRatesTaxRateProductsReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L84) +[medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L84) ___ ### addShippingOptions -▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L116) +[medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L116) ___ ### create -▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostTaxRatesReq`](internal-25.AdminPostTaxRatesReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesReq`](internal-27.AdminPostTaxRatesReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L53) +[medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L53) ___ @@ -116,139 +116,139 @@ ___ #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L180) +[medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L180) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-25.md#admintaxrateslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-27.md#admintaxrateslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetTaxRatesParams`](internal-25.AdminGetTaxRatesParams.md) | +| `query?` | [`AdminGetTaxRatesParams`](internal-27.AdminGetTaxRatesParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-25.md#admintaxrateslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-27.md#admintaxrateslistres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L39) +[medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L39) ___ ### removeProductTypes -▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | +| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L148) +[medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L148) ___ ### removeProducts -▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md) | +| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L132) +[medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L132) ___ ### removeShippingOptions -▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | +| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L164) +[medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L164) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L24) +[medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L24) ___ ### update -▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-25.AdminPostTaxRatesTaxRateReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-27.AdminPostTaxRatesTaxRateReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/tax-rates.ts#L68) +[medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/tax-rates.ts#L68) diff --git a/docs/content/references/js-client/classes/AdminUploadsResource.md b/docs/content/references/js-client/classes/AdminUploadsResource.md index 5efb1c16ac..5caafe62bd 100644 --- a/docs/content/references/js-client/classes/AdminUploadsResource.md +++ b/docs/content/references/js-client/classes/AdminUploadsResource.md @@ -20,27 +20,27 @@ #### Defined in -[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/uploads.ts#L14) +[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/uploads.ts#L14) ## Methods ### create -▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-26.md#adminuploadsres)\> +▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-28.md#adminuploadsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `file` | [`IAdminPostUploadsFileReq`](internal-26.IAdminPostUploadsFileReq.md) | +| `file` | [`IAdminPostUploadsFileReq`](internal-28.IAdminPostUploadsFileReq.md) | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-26.md#adminuploadsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-28.md#adminuploadsres)\> #### Defined in -[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/uploads.ts#L18) +[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/uploads.ts#L18) ___ @@ -52,7 +52,7 @@ ___ | Name | Type | | :------ | :------ | -| `payload` | [`AdminDeleteUploadsReq`](internal-26.AdminDeleteUploadsReq.md) | +| `payload` | [`AdminDeleteUploadsReq`](internal-28.AdminDeleteUploadsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns @@ -61,25 +61,25 @@ ___ #### Defined in -[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/uploads.ts#L27) +[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/uploads.ts#L27) ___ ### getPresignedDownloadUrl -▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-26.md#adminuploadsdownloadurlres)\> +▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-28.md#adminuploadsdownloadurlres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-26.AdminPostUploadsDownloadUrlReq.md) | +| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-28.AdminPostUploadsDownloadUrlReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-26.md#adminuploadsdownloadurlres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-28.md#adminuploadsdownloadurlres)\> #### Defined in -[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/uploads.ts#L36) +[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/uploads.ts#L36) diff --git a/docs/content/references/js-client/classes/AdminUsersResource.md b/docs/content/references/js-client/classes/AdminUsersResource.md index c2c346bc4f..4a3263e6c3 100644 --- a/docs/content/references/js-client/classes/AdminUsersResource.md +++ b/docs/content/references/js-client/classes/AdminUsersResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> **`Description`** @@ -20,18 +20,18 @@ creates a user with the provided information | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminCreateUserPayload`](../modules/internal-27.md#admincreateuserpayload) | user creation request body | +| `payload` | [`AdminCreateUserPayload`](../modules/internal-29.md#admincreateuserpayload) | user creation request body | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> created user #### Defined in -[medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/users.ts#L64) +[medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/users.ts#L64) ___ @@ -58,13 +58,13 @@ delete response #### Defined in -[medusa-js/src/resources/admin/users.ts:94](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/users.ts#L94) +[medusa-js/src/resources/admin/users.ts:94](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/users.ts#L94) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-27.md#adminuserslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-29.md#adminuserslistres)\> **`Description`** @@ -78,19 +78,19 @@ lists all users #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-27.md#adminuserslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-29.md#adminuserslistres)\> a list of all users #### Defined in -[medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/users.ts#L106) +[medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/users.ts#L106) ___ ### resetPassword -▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\> +▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> **`Description`** @@ -100,22 +100,22 @@ resets the users password given the correct token. | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminResetPasswordRequest`](internal-27.AdminResetPasswordRequest.md) | reset password information. | +| `payload` | [`AdminResetPasswordRequest`](internal-29.AdminResetPasswordRequest.md) | reset password information. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> #### Defined in -[medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/users.ts#L36) +[medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/users.ts#L36) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> Retrieves a given user @@ -128,13 +128,13 @@ Retrieves a given user #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> the user #### Defined in -[medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/users.ts#L50) +[medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/users.ts#L50) ___ @@ -150,7 +150,7 @@ resets password by re-sending password token. | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminResetPasswordTokenRequest`](internal-27.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. | +| `payload` | [`AdminResetPasswordTokenRequest`](internal-29.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns @@ -159,13 +159,13 @@ resets password by re-sending password token. #### Defined in -[medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/users.ts#L22) +[medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/users.ts#L22) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> **`Description`** @@ -176,15 +176,15 @@ updates a given user | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the user to update | -| `payload` | [`AdminUpdateUserPayload`](../modules/internal-27.md#adminupdateuserpayload) | user update request body | +| `payload` | [`AdminUpdateUserPayload`](../modules/internal-29.md#adminupdateuserpayload) | user update request body | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> the updated user #### Defined in -[medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/users.ts#L79) +[medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/users.ts#L79) diff --git a/docs/content/references/js-client/classes/AdminVariantsResource.md b/docs/content/references/js-client/classes/AdminVariantsResource.md index 995f03ac49..a805847049 100644 --- a/docs/content/references/js-client/classes/AdminVariantsResource.md +++ b/docs/content/references/js-client/classes/AdminVariantsResource.md @@ -10,19 +10,19 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-28.md#adminvariantslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-30.md#adminvariantslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetVariantsParams`](internal-28.AdminGetVariantsParams.md) | +| `query?` | [`AdminGetVariantsParams`](internal-30.AdminGetVariantsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-28.md#adminvariantslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-30.md#adminvariantslistres)\> #### Defined in -[medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/admin/variants.ts#L7) +[medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/admin/variants.ts#L7) diff --git a/docs/content/references/js-client/classes/AuthResource.md b/docs/content/references/js-client/classes/AuthResource.md index a24a087d5d..4591e397a0 100644 --- a/docs/content/references/js-client/classes/AuthResource.md +++ b/docs/content/references/js-client/classes/AuthResource.md @@ -10,7 +10,7 @@ ### authenticate -▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-29.md#storeauthres)\> +▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-31.md#storeauthres)\> **`Description`** @@ -20,16 +20,16 @@ Authenticates a customer using email and password combination | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostAuthReq`](internal-29.StorePostAuthReq.md) | authentication payload | +| `payload` | [`StorePostAuthReq`](internal-31.StorePostAuthReq.md) | authentication payload | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-29.md#storeauthres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-31.md#storeauthres)\> #### Defined in -[medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/auth.ts#L16) +[medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/auth.ts#L16) ___ @@ -53,13 +53,13 @@ Removes authentication session #### Defined in -[medusa-js/src/resources/auth.ts:25](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/auth.ts#L25) +[medusa-js/src/resources/auth.ts:25](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/auth.ts#L25) ___ ### exists -▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-29.md#storegetauthemailres)\> +▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-31.md#storegetauthemailres)\> **`Description`** @@ -74,17 +74,17 @@ Check if email exists #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-29.md#storegetauthemailres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-31.md#storegetauthemailres)\> #### Defined in -[medusa-js/src/resources/auth.ts:47](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/auth.ts#L47) +[medusa-js/src/resources/auth.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/auth.ts#L47) ___ ### getSession -▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-29.md#storeauthres)\> +▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-31.md#storeauthres)\> **`Description`** @@ -99,8 +99,8 @@ Usually used to check if authenticated session is alive. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-29.md#storeauthres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-31.md#storeauthres)\> #### Defined in -[medusa-js/src/resources/auth.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/auth.ts#L36) +[medusa-js/src/resources/auth.ts:36](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/auth.ts#L36) diff --git a/docs/content/references/js-client/classes/CartsResource.md b/docs/content/references/js-client/classes/CartsResource.md index c62897a720..9f33a3ab24 100644 --- a/docs/content/references/js-client/classes/CartsResource.md +++ b/docs/content/references/js-client/classes/CartsResource.md @@ -14,13 +14,13 @@ #### Defined in -[medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L15) +[medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L15) ## Methods ### addShippingMethod -▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Adds a shipping method to cart @@ -29,22 +29,22 @@ Adds a shipping method to cart | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | Id of cart | -| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-30.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data | +| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-32.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L24) +[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L24) ___ ### complete -▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-30.md#storecompletecartres)\> +▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-32.md#storecompletecartres)\> Completes a cart. Payment authorization is attempted and if more work is required, we simply return the cart for further updates. @@ -61,17 +61,17 @@ If not provuided, we will generate one for the request. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-30.md#storecompletecartres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-32.md#storecompletecartres)\> #### Defined in -[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L43) +[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L43) ___ ### create -▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Creates a cart @@ -79,22 +79,22 @@ Creates a cart | Name | Type | Description | | :------ | :------ | :------ | -| `payload?` | [`StorePostCartReq`](internal-30.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty | +| `payload?` | [`StorePostCartReq`](internal-32.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L58) +[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L58) ___ ### createPaymentSessions -▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Creates payment sessions. Initializes the payment sessions that can be used to pay for the items of the cart. @@ -109,17 +109,17 @@ This is usually called when a customer proceeds to checkout. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L74) +[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L74) ___ ### deleteDiscount -▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Removes a discount from cart. @@ -133,17 +133,17 @@ Removes a discount from cart. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L89) +[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L89) ___ ### deletePaymentSession -▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Removes a payment session from a cart. Can be useful in case a payment has failed @@ -158,17 +158,17 @@ Can be useful in case a payment has failed #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L106) +[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L106) ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Refreshes a payment session. @@ -182,17 +182,17 @@ Refreshes a payment session. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L122) +[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L122) ___ ### retrieve -▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Retrieves a cart @@ -205,17 +205,17 @@ Retrieves a cart #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L137) +[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L137) ___ ### setPaymentSession -▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Refreshes a payment session. @@ -224,22 +224,22 @@ Refreshes a payment session. | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-30.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" | +| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-32.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L152) +[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L152) ___ ### update -▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Updates a cart @@ -248,22 +248,22 @@ Updates a cart | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `payload` | [`StorePostCartsCartReq`](internal-30.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address | +| `payload` | [`StorePostCartsCartReq`](internal-32.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L168) +[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L168) ___ ### updatePaymentSession -▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Updates the payment method @@ -273,13 +273,13 @@ Updates the payment method | :------ | :------ | :------ | | `cart_id` | `string` | is required | | `provider_id` | `string` | is required | -| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-30.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | +| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-32.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/carts.ts#L185) +[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/carts.ts#L185) diff --git a/docs/content/references/js-client/classes/CollectionsResource.md b/docs/content/references/js-client/classes/CollectionsResource.md index c37d1621b0..79d63faf3b 100644 --- a/docs/content/references/js-client/classes/CollectionsResource.md +++ b/docs/content/references/js-client/classes/CollectionsResource.md @@ -10,7 +10,7 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-31.md#storecollectionslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-33.md#storecollectionslistres)\> **`Description`** @@ -20,22 +20,22 @@ Retrieves a list of collections | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`StoreGetCollectionsParams`](internal-31.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `query?` | [`StoreGetCollectionsParams`](internal-33.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-31.md#storecollectionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-33.md#storecollectionslistres)\> #### Defined in -[medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/collections.ts#L28) +[medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/collections.ts#L28) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-31.md#storecollectionsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-33.md#storecollectionsres)\> **`Description`** @@ -50,8 +50,8 @@ Retrieves a single collection #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-31.md#storecollectionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-33.md#storecollectionsres)\> #### Defined in -[medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/collections.ts#L17) +[medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/collections.ts#L17) diff --git a/docs/content/references/js-client/classes/CustomerResource.md b/docs/content/references/js-client/classes/CustomerResource.md index c8d1ac03d1..8a4edd1a62 100644 --- a/docs/content/references/js-client/classes/CustomerResource.md +++ b/docs/content/references/js-client/classes/CustomerResource.md @@ -14,7 +14,7 @@ #### Defined in -[medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/customers.ts#L17) +[medusa-js/src/resources/customers.ts:18](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/customers.ts#L18) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/resources/customers.ts:16](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/customers.ts#L16) +[medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/customers.ts#L17) ## Methods @@ -38,7 +38,7 @@ Creates a customer | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersReq`](internal-32.StorePostCustomersReq.md) | information of customer | +| `payload` | [`StorePostCustomersReq`](internal-34.StorePostCustomersReq.md) | information of customer | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns @@ -47,7 +47,7 @@ Creates a customer #### Defined in -[medusa-js/src/resources/customers.ts:25](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/customers.ts#L25) +[medusa-js/src/resources/customers.ts:26](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/customers.ts#L26) ___ @@ -62,7 +62,7 @@ The token is not returned but should be sent out to the customer in an email. | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-32.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token | +| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-34.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns @@ -71,13 +71,13 @@ The token is not returned but should be sent out to the customer in an email. #### Defined in -[medusa-js/src/resources/customers.ts:100](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/customers.ts#L100) +[medusa-js/src/resources/customers.ts:101](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/customers.ts#L101) ___ ### listOrders -▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-32.md#storecustomerslistordersres)\> +▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-34.md#storecustomerslistordersres)\> Retrieve customer orders @@ -85,16 +85,16 @@ Retrieve customer orders | Name | Type | Description | | :------ | :------ | :------ | -| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-32.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | +| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-34.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-32.md#storecustomerslistordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-34.md#storecustomerslistordersres)\> #### Defined in -[medusa-js/src/resources/customers.ts:65](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/customers.ts#L65) +[medusa-js/src/resources/customers.ts:66](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/customers.ts#L66) ___ @@ -108,7 +108,7 @@ Resets customer password | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-32.StorePostCustomersCustomerPasswordTokenReq.md) | info used to reset customer password | +| `payload` | [`StorePostCustomersResetPasswordReq`](internal-34.StorePostCustomersResetPasswordReq.md) | info used to reset customer password | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns @@ -117,7 +117,7 @@ Resets customer password #### Defined in -[medusa-js/src/resources/customers.ts:85](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/customers.ts#L85) +[medusa-js/src/resources/customers.ts:86](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/customers.ts#L86) ___ @@ -139,7 +139,7 @@ Retrieves the customer that is currently logged #### Defined in -[medusa-js/src/resources/customers.ts:38](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/customers.ts#L38) +[medusa-js/src/resources/customers.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/customers.ts#L39) ___ @@ -153,7 +153,7 @@ Updates a customer | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerReq`](internal-32.StorePostCustomersCustomerReq.md) | information to update customer with | +| `payload` | [`StorePostCustomersCustomerReq`](internal-34.StorePostCustomersCustomerReq.md) | information to update customer with | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns @@ -162,4 +162,4 @@ Updates a customer #### Defined in -[medusa-js/src/resources/customers.ts:51](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/customers.ts#L51) +[medusa-js/src/resources/customers.ts:52](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/customers.ts#L52) diff --git a/docs/content/references/js-client/classes/GiftCardsResource.md b/docs/content/references/js-client/classes/GiftCardsResource.md index 43522566c1..b740c6bf74 100644 --- a/docs/content/references/js-client/classes/GiftCardsResource.md +++ b/docs/content/references/js-client/classes/GiftCardsResource.md @@ -10,7 +10,7 @@ ### retrieve -▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-33.md#storegiftcardsres)\> +▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-35.md#storegiftcardsres)\> **`Description`** @@ -25,8 +25,8 @@ Retrieves a single GiftCard #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-33.md#storegiftcardsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-35.md#storegiftcardsres)\> #### Defined in -[medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/gift-cards.ts#L12) +[medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/gift-cards.ts#L12) diff --git a/docs/content/references/js-client/classes/LineItemsResource.md b/docs/content/references/js-client/classes/LineItemsResource.md index c5d191c6f5..e330ffea2b 100644 --- a/docs/content/references/js-client/classes/LineItemsResource.md +++ b/docs/content/references/js-client/classes/LineItemsResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Creates a line-item for a cart @@ -19,22 +19,22 @@ Creates a line-item for a cart | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | id of cart | -| `payload` | [`StorePostCartsCartLineItemsReq`](internal-34.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item | +| `payload` | [`StorePostCartsCartLineItemsReq`](internal-36.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/line-items.ts#L17) +[medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/line-items.ts#L17) ___ ### delete -▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Remove a line-item from a cart @@ -48,17 +48,17 @@ Remove a line-item from a cart #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/line-items.ts#L50) +[medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/line-items.ts#L50) ___ ### update -▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> Updates a line-item. Only quantity updates are allowed @@ -69,13 +69,13 @@ Only quantity updates are allowed | :------ | :------ | :------ | | `cart_id` | `string` | id of cart | | `line_id` | `string` | id of item to update | -| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-34.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item | +| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-36.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/line-items.ts#L34) +[medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/line-items.ts#L34) diff --git a/docs/content/references/js-client/classes/OrderEditsResource.md b/docs/content/references/js-client/classes/OrderEditsResource.md new file mode 100644 index 0000000000..c99b1f7d5c --- /dev/null +++ b/docs/content/references/js-client/classes/OrderEditsResource.md @@ -0,0 +1,71 @@ +# Class: OrderEditsResource + +## Hierarchy + +- `default` + + ↳ **`OrderEditsResource`** + +## Methods + +### complete + +▸ **complete**(`id`, `customHeaders?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[medusa-js/src/resources/order-edits.ts:26](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/order-edits.ts#L26) + +___ + +### decline + +▸ **decline**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-37.StorePostOrderEditsOrderEditDecline.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[medusa-js/src/resources/order-edits.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/order-edits.ts#L17) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-37.md#storeordereditsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-37.md#storeordereditsres)\> + +#### Defined in + +[medusa-js/src/resources/order-edits.ts:9](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/order-edits.ts#L9) diff --git a/docs/content/references/js-client/classes/OrdersResource.md b/docs/content/references/js-client/classes/OrdersResource.md index 2a29b42397..fce6ada0b8 100644 --- a/docs/content/references/js-client/classes/OrdersResource.md +++ b/docs/content/references/js-client/classes/OrdersResource.md @@ -10,7 +10,7 @@ ### lookupOrder -▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\> +▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> **`Description`** @@ -20,22 +20,22 @@ Look up an order using order details | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StoreGetOrdersParams`](internal-35.StoreGetOrdersParams.md) | details used to look up the order | +| `payload` | [`StoreGetOrdersParams`](internal-38.StoreGetOrdersParams.md) | details used to look up the order | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> #### Defined in -[medusa-js/src/resources/orders.ts:41](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/orders.ts#L41) +[medusa-js/src/resources/orders.ts:41](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/orders.ts#L41) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> **`Description`** @@ -50,17 +50,17 @@ Retrieves an order #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> #### Defined in -[medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/orders.ts#L13) +[medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/orders.ts#L13) ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\> +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> **`Description`** @@ -75,8 +75,8 @@ Retrieves an order by cart id #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> #### Defined in -[medusa-js/src/resources/orders.ts:27](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/orders.ts#L27) +[medusa-js/src/resources/orders.ts:27](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/orders.ts#L27) diff --git a/docs/content/references/js-client/classes/PaymentMethodsResource.md b/docs/content/references/js-client/classes/PaymentMethodsResource.md index 2ac11d3d86..f561df32a3 100644 --- a/docs/content/references/js-client/classes/PaymentMethodsResource.md +++ b/docs/content/references/js-client/classes/PaymentMethodsResource.md @@ -10,7 +10,7 @@ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-36.md#storecustomerslistpaymentmethodsres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-39.md#storecustomerslistpaymentmethodsres)\> Lists customer payment methods @@ -22,8 +22,8 @@ Lists customer payment methods #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-36.md#storecustomerslistpaymentmethodsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-39.md#storecustomerslistpaymentmethodsres)\> #### Defined in -[medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/payment-methods.ts#L12) +[medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/payment-methods.ts#L12) diff --git a/docs/content/references/js-client/classes/ProductVariantsResource.md b/docs/content/references/js-client/classes/ProductVariantsResource.md index b84a8a49d2..9758a42e5d 100644 --- a/docs/content/references/js-client/classes/ProductVariantsResource.md +++ b/docs/content/references/js-client/classes/ProductVariantsResource.md @@ -10,7 +10,7 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-37.md#storevariantslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-40.md#storevariantslistres)\> **`Description`** @@ -20,22 +20,22 @@ Retrieves a list of of Product Variants | Name | Type | | :------ | :------ | -| `query?` | [`StoreGetVariantsParams`](internal-37.StoreGetVariantsParams.md) | +| `query?` | [`StoreGetVariantsParams`](internal-40.StoreGetVariantsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-37.md#storevariantslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-40.md#storevariantslistres)\> #### Defined in -[medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/product-variants.ts#L28) +[medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/product-variants.ts#L28) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-37.md#storevariantsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-40.md#storevariantsres)\> **`Description`** @@ -50,8 +50,8 @@ Retrieves a single product variant #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-37.md#storevariantsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-40.md#storevariantsres)\> #### Defined in -[medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/product-variants.ts#L17) +[medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/product-variants.ts#L17) diff --git a/docs/content/references/js-client/classes/ProductsResource.md b/docs/content/references/js-client/classes/ProductsResource.md index 8dd2be0f27..59fae3140b 100644 --- a/docs/content/references/js-client/classes/ProductsResource.md +++ b/docs/content/references/js-client/classes/ProductsResource.md @@ -14,13 +14,13 @@ #### Defined in -[medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/products.ts#L14) +[medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/products.ts#L14) ## Methods ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-38.md#storeproductslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-41.md#storeproductslistres)\> **`Description`** @@ -30,22 +30,22 @@ Retrieves a list of products | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`StoreGetProductsParams`](internal-38.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `query?` | [`StoreGetProductsParams`](internal-41.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-38.md#storeproductslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-41.md#storeproductslistres)\> #### Defined in -[medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/products.ts#L50) +[medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/products.ts#L50) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-38.md#storeproductsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-41.md#storeproductsres)\> **`Description`** @@ -60,17 +60,17 @@ Retrieves a single Product #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-38.md#storeproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-41.md#storeproductsres)\> #### Defined in -[medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/products.ts#L22) +[medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/products.ts#L22) ___ ### search -▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-38.md#storepostsearchres)\> +▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-41.md#storepostsearchres)\> **`Description`** @@ -80,13 +80,13 @@ Searches for products | Name | Type | Description | | :------ | :------ | :------ | -| `searchOptions` | [`StorePostSearchReq`](internal-38.StorePostSearchReq.md) | is required | +| `searchOptions` | [`StorePostSearchReq`](internal-41.StorePostSearchReq.md) | is required | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-38.md#storepostsearchres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-41.md#storepostsearchres)\> #### Defined in -[medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/products.ts#L36) +[medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/products.ts#L36) diff --git a/docs/content/references/js-client/classes/RegionsResource.md b/docs/content/references/js-client/classes/RegionsResource.md index 2312ef3c8f..ba3e720491 100644 --- a/docs/content/references/js-client/classes/RegionsResource.md +++ b/docs/content/references/js-client/classes/RegionsResource.md @@ -10,7 +10,7 @@ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-39.md#storeregionslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-42.md#storeregionslistres)\> **`Description`** @@ -24,17 +24,17 @@ Retrieves a list of regions #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-39.md#storeregionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-42.md#storeregionslistres)\> #### Defined in -[medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/regions.ts#L11) +[medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/regions.ts#L11) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-39.md#storeregionsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-42.md#storeregionsres)\> **`Description`** @@ -49,8 +49,8 @@ Retrieves a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-39.md#storeregionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-42.md#storeregionsres)\> #### Defined in -[medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/regions.ts#L22) +[medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/regions.ts#L22) diff --git a/docs/content/references/js-client/classes/ReturnReasonsResource.md b/docs/content/references/js-client/classes/ReturnReasonsResource.md index 7a9de4981c..d9bafc7a36 100644 --- a/docs/content/references/js-client/classes/ReturnReasonsResource.md +++ b/docs/content/references/js-client/classes/ReturnReasonsResource.md @@ -10,7 +10,7 @@ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-40.md#storereturnreasonslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-43.md#storereturnreasonslistres)\> Lists return reasons defined in Medusa Admin @@ -22,17 +22,17 @@ Lists return reasons defined in Medusa Admin #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-40.md#storereturnreasonslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-43.md#storereturnreasonslistres)\> #### Defined in -[medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/return-reasons.ts#L25) +[medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/return-reasons.ts#L25) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-40.md#storereturnreasonsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-43.md#storereturnreasonsres)\> **`Description`** @@ -47,8 +47,8 @@ Retrieves a single Return Reason #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-40.md#storereturnreasonsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-43.md#storereturnreasonsres)\> #### Defined in -[medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/return-reasons.ts#L15) +[medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/return-reasons.ts#L15) diff --git a/docs/content/references/js-client/classes/ReturnsResource.md b/docs/content/references/js-client/classes/ReturnsResource.md index 0deab43443..1ccd6ac2e9 100644 --- a/docs/content/references/js-client/classes/ReturnsResource.md +++ b/docs/content/references/js-client/classes/ReturnsResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-41.md#storereturnsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-44.md#storereturnsres)\> Creates a return request @@ -18,13 +18,13 @@ Creates a return request | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostReturnsReq`](internal-41.StorePostReturnsReq.md) | details needed to create a return | +| `payload` | [`StorePostReturnsReq`](internal-44.StorePostReturnsReq.md) | details needed to create a return | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-41.md#storereturnsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-44.md#storereturnsres)\> #### Defined in -[medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/returns.ts#L12) +[medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/returns.ts#L12) diff --git a/docs/content/references/js-client/classes/ShippingOptionsResource.md b/docs/content/references/js-client/classes/ShippingOptionsResource.md index bdef5b7c54..34488ef256 100644 --- a/docs/content/references/js-client/classes/ShippingOptionsResource.md +++ b/docs/content/references/js-client/classes/ShippingOptionsResource.md @@ -10,7 +10,7 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-45.md#storeshippingoptionslistres)\> **`Description`** @@ -20,22 +20,22 @@ Lists shiping options available | Name | Type | | :------ | :------ | -| `query?` | [`StoreGetShippingOptionsParams`](internal-42.StoreGetShippingOptionsParams.md) | +| `query?` | [`StoreGetShippingOptionsParams`](internal-45.StoreGetShippingOptionsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-45.md#storeshippingoptionslistres)\> #### Defined in -[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/shipping-options.ts#L27) +[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/shipping-options.ts#L27) ___ ### listCartOptions -▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\> +▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-45.md#storeshippingoptionslistres)\> **`Description`** @@ -50,8 +50,8 @@ Lists shiping options available for a cart #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-45.md#storeshippingoptionslistres)\> #### Defined in -[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/shipping-options.ts#L16) +[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/shipping-options.ts#L16) diff --git a/docs/content/references/js-client/classes/SwapsResource.md b/docs/content/references/js-client/classes/SwapsResource.md index 06f302b839..ecebed1337 100644 --- a/docs/content/references/js-client/classes/SwapsResource.md +++ b/docs/content/references/js-client/classes/SwapsResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\> **`Description`** @@ -20,22 +20,22 @@ Creates a swap from a cart | Name | Type | | :------ | :------ | -| `payload` | [`StorePostSwapsReq`](internal-43.StorePostSwapsReq.md) | +| `payload` | [`StorePostSwapsReq`](internal-46.StorePostSwapsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\> #### Defined in -[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/swaps.ts#L12) +[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/swaps.ts#L12) ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\> +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\> **`Description`** @@ -50,8 +50,8 @@ Retrieves a swap by cart id #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-46.md#storeswapsres)\> #### Defined in -[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/resources/swaps.ts#L23) +[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/resources/swaps.ts#L23) diff --git a/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md b/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md index 17bfb6c6eb..98c60d0051 100644 --- a/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md +++ b/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/auth/create-session.d.ts:43 +medusa/dist/api/routes/admin/auth/create-session.d.ts:74 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/auth/create-session.d.ts:44 +medusa/dist/api/routes/admin/auth/create-session.d.ts:75 diff --git a/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptReq.md b/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptReq.md new file mode 100644 index 0000000000..adae519c79 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostInvitesInviteAcceptReq + +[internal](../modules/internal-10.md).AdminPostInvitesInviteAcceptReq + +## Properties + +### token + +• **token**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:99 + +___ + +### user + +• **user**: [`AdminPostInvitesInviteAcceptUserReq`](internal-10.AdminPostInvitesInviteAcceptUserReq.md) + +#### Defined in + +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:100 diff --git a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md b/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md rename to docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md index 197d401c2c..7845394229 100644 --- a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md +++ b/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md @@ -1,6 +1,6 @@ # Class: AdminPostInvitesInviteAcceptUserReq -[internal](../modules/internal-9.md).AdminPostInvitesInviteAcceptUserReq +[internal](../modules/internal-10.md).AdminPostInvitesInviteAcceptUserReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:44 +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:94 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:45 +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:95 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:46 +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:96 diff --git a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesReq.md b/docs/content/references/js-client/classes/internal-10.AdminPostInvitesReq.md similarity index 52% rename from docs/content/references/js-client/classes/internal-9.AdminPostInvitesReq.md rename to docs/content/references/js-client/classes/internal-10.AdminPostInvitesReq.md index 98bfee9e4b..2224323962 100644 --- a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesReq.md +++ b/docs/content/references/js-client/classes/internal-10.AdminPostInvitesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostInvitesReq -[internal](../modules/internal-9.md).AdminPostInvitesReq +[internal](../modules/internal-10.md).AdminPostInvitesReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/invites/create-invite.d.ts:34 +medusa/dist/api/routes/admin/invites/create-invite.d.ts:76 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/invites/create-invite.d.ts:33 +medusa/dist/api/routes/admin/invites/create-invite.d.ts:75 diff --git a/docs/content/references/js-client/classes/internal-10.AdminPostNotesNoteReq.md b/docs/content/references/js-client/classes/internal-10.AdminPostNotesNoteReq.md deleted file mode 100644 index a1eca1d459..0000000000 --- a/docs/content/references/js-client/classes/internal-10.AdminPostNotesNoteReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostNotesNoteReq - -[internal](../modules/internal-10.md).AdminPostNotesNoteReq - -## Properties - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notes/update-note.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal-9.Invite.md b/docs/content/references/js-client/classes/internal-10.Invite.md similarity index 97% rename from docs/content/references/js-client/classes/internal-9.Invite.md rename to docs/content/references/js-client/classes/internal-10.Invite.md index 491717e1ed..2058bf1433 100644 --- a/docs/content/references/js-client/classes/internal-9.Invite.md +++ b/docs/content/references/js-client/classes/internal-10.Invite.md @@ -1,6 +1,6 @@ # Class: Invite -[internal](../modules/internal-9.md).Invite +[internal](../modules/internal-10.md).Invite Base abstract entity for all entities diff --git a/docs/content/references/js-client/classes/internal-10.AdminGetNotesParams.md b/docs/content/references/js-client/classes/internal-11.AdminGetNotesParams.md similarity index 52% rename from docs/content/references/js-client/classes/internal-10.AdminGetNotesParams.md rename to docs/content/references/js-client/classes/internal-11.AdminGetNotesParams.md index d0ea084c89..c8f1f5dccd 100644 --- a/docs/content/references/js-client/classes/internal-10.AdminGetNotesParams.md +++ b/docs/content/references/js-client/classes/internal-11.AdminGetNotesParams.md @@ -1,6 +1,6 @@ # Class: AdminGetNotesParams -[internal](../modules/internal-10.md).AdminGetNotesParams +[internal](../modules/internal-11.md).AdminGetNotesParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/notes/list-notes.d.ts:38 +medusa/dist/api/routes/admin/notes/list-notes.d.ts:69 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notes/list-notes.d.ts:39 +medusa/dist/api/routes/admin/notes/list-notes.d.ts:70 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notes/list-notes.d.ts:37 +medusa/dist/api/routes/admin/notes/list-notes.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-11.AdminPostNotesNoteReq.md b/docs/content/references/js-client/classes/internal-11.AdminPostNotesNoteReq.md new file mode 100644 index 0000000000..21b2bddc6e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-11.AdminPostNotesNoteReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostNotesNoteReq + +[internal](../modules/internal-11.md).AdminPostNotesNoteReq + +## Properties + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/notes/update-note.d.ts:71 diff --git a/docs/content/references/js-client/classes/internal-10.AdminPostNotesReq.md b/docs/content/references/js-client/classes/internal-11.AdminPostNotesReq.md similarity index 52% rename from docs/content/references/js-client/classes/internal-10.AdminPostNotesReq.md rename to docs/content/references/js-client/classes/internal-11.AdminPostNotesReq.md index d819f25fe7..bb6d6c494b 100644 --- a/docs/content/references/js-client/classes/internal-10.AdminPostNotesReq.md +++ b/docs/content/references/js-client/classes/internal-11.AdminPostNotesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostNotesReq -[internal](../modules/internal-10.md).AdminPostNotesReq +[internal](../modules/internal-11.md).AdminPostNotesReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/notes/create-note.d.ts:41 +medusa/dist/api/routes/admin/notes/create-note.d.ts:82 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notes/create-note.d.ts:42 +medusa/dist/api/routes/admin/notes/create-note.d.ts:83 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notes/create-note.d.ts:43 +medusa/dist/api/routes/admin/notes/create-note.d.ts:84 diff --git a/docs/content/references/js-client/classes/internal-10.Note.md b/docs/content/references/js-client/classes/internal-11.Note.md similarity index 97% rename from docs/content/references/js-client/classes/internal-10.Note.md rename to docs/content/references/js-client/classes/internal-11.Note.md index 5788acab18..7c87f94680 100644 --- a/docs/content/references/js-client/classes/internal-10.Note.md +++ b/docs/content/references/js-client/classes/internal-11.Note.md @@ -1,6 +1,6 @@ # Class: Note -[internal](../modules/internal-10.md).Note +[internal](../modules/internal-11.md).Note Base abstract entity for all entities diff --git a/docs/content/references/js-client/classes/internal-11.AdminGetNotificationsParams.md b/docs/content/references/js-client/classes/internal-12.AdminGetNotificationsParams.md similarity index 91% rename from docs/content/references/js-client/classes/internal-11.AdminGetNotificationsParams.md rename to docs/content/references/js-client/classes/internal-12.AdminGetNotificationsParams.md index dd8105efac..b55591a752 100644 --- a/docs/content/references/js-client/classes/internal-11.AdminGetNotificationsParams.md +++ b/docs/content/references/js-client/classes/internal-12.AdminGetNotificationsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetNotificationsParams -[internal](../modules/internal-11.md).AdminGetNotificationsParams +[internal](../modules/internal-12.md).AdminGetNotificationsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:38 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:69 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:37 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:68 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:36 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:67 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:42 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:73 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:34 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:65 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:35 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:66 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:40 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:71 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:39 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:70 ___ @@ -90,4 +90,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:41 +medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:72 diff --git a/docs/content/references/js-client/classes/internal-11.AdminPostNotificationsNotificationResendReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostNotificationsNotificationResendReq.md similarity index 74% rename from docs/content/references/js-client/classes/internal-11.AdminPostNotificationsNotificationResendReq.md rename to docs/content/references/js-client/classes/internal-12.AdminPostNotificationsNotificationResendReq.md index 2c83b04896..93770c95e5 100644 --- a/docs/content/references/js-client/classes/internal-11.AdminPostNotificationsNotificationResendReq.md +++ b/docs/content/references/js-client/classes/internal-12.AdminPostNotificationsNotificationResendReq.md @@ -1,6 +1,6 @@ # Class: AdminPostNotificationsNotificationResendReq -[internal](../modules/internal-11.md).AdminPostNotificationsNotificationResendReq +[internal](../modules/internal-12.md).AdminPostNotificationsNotificationResendReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/notifications/resend-notification.d.ts:32 +medusa/dist/api/routes/admin/notifications/resend-notification.d.ts:63 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md deleted file mode 100644 index 69ba6a2e19..0000000000 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostOrdersOrderFulfillmentsReq - -[internal](../modules/internal-12.md).AdminPostOrdersOrderFulfillmentsReq - -## Properties - -### items - -• **items**: [`Item`](internal-12.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:51 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:53 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:52 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md deleted file mode 100644 index 4d4c5a2e49..0000000000 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsReq - -[internal](../modules/internal-12.md).AdminPostOrdersOrderSwapsSwapFulfillmentsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:36 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:37 diff --git a/docs/content/references/js-client/classes/internal-12.CustomShippingOption.md b/docs/content/references/js-client/classes/internal-12.CustomShippingOption.md deleted file mode 100644 index 4df43970ee..0000000000 --- a/docs/content/references/js-client/classes/internal-12.CustomShippingOption.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: CustomShippingOption - -[internal](../modules/internal-12.md).CustomShippingOption - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:116 - -___ - -### price - -• **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:117 diff --git a/docs/content/references/js-client/classes/internal-12.Image.md b/docs/content/references/js-client/classes/internal-12.Image.md deleted file mode 100644 index d1eb0dc155..0000000000 --- a/docs/content/references/js-client/classes/internal-12.Image.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: Image - -[internal](../modules/internal-12.md).Image - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:125 - -___ - -### url - -• `Optional` **url**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:126 diff --git a/docs/content/references/js-client/classes/internal-12.Item-2.md b/docs/content/references/js-client/classes/internal-12.Item-2.md deleted file mode 100644 index 83f6231f23..0000000000 --- a/docs/content/references/js-client/classes/internal-12.Item-2.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: Item - -[internal](../modules/internal-12.md).Item - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:117 - -___ - -### images - -• **images**: [`Image`](internal-12.Image.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:120 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:122 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:118 - -___ - -### reason - -• `Optional` **reason**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:119 - -___ - -### tags - -• **tags**: [`Tag`](internal-12.Tag.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:121 diff --git a/docs/content/references/js-client/classes/internal-12.Item.md b/docs/content/references/js-client/classes/internal-12.Item.md deleted file mode 100644 index d829cd76ee..0000000000 --- a/docs/content/references/js-client/classes/internal-12.Item.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: Item - -[internal](../modules/internal-12.md).Item - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:56 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal-11.Notification.md b/docs/content/references/js-client/classes/internal-12.Notification.md similarity index 90% rename from docs/content/references/js-client/classes/internal-11.Notification.md rename to docs/content/references/js-client/classes/internal-12.Notification.md index f138b548db..9719facba1 100644 --- a/docs/content/references/js-client/classes/internal-11.Notification.md +++ b/docs/content/references/js-client/classes/internal-12.Notification.md @@ -1,6 +1,6 @@ # Class: Notification -[internal](../modules/internal-11.md).Notification +[internal](../modules/internal-12.md).Notification Base abstract entity for all entities @@ -102,7 +102,7 @@ ___ ### parent\_notification -• **parent\_notification**: [`Notification`](internal-11.Notification.md) +• **parent\_notification**: [`Notification`](internal-12.Notification.md) #### Defined in @@ -112,7 +112,7 @@ ___ ### provider -• **provider**: [`NotificationProvider`](internal-11.NotificationProvider.md) +• **provider**: [`NotificationProvider`](internal-12.NotificationProvider.md) #### Defined in @@ -132,7 +132,7 @@ ___ ### resends -• **resends**: [`Notification`](internal-11.Notification.md)[] +• **resends**: [`Notification`](internal-12.Notification.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-11.NotificationProvider.md b/docs/content/references/js-client/classes/internal-12.NotificationProvider.md similarity index 81% rename from docs/content/references/js-client/classes/internal-11.NotificationProvider.md rename to docs/content/references/js-client/classes/internal-12.NotificationProvider.md index 103352d80b..cf8fa64584 100644 --- a/docs/content/references/js-client/classes/internal-11.NotificationProvider.md +++ b/docs/content/references/js-client/classes/internal-12.NotificationProvider.md @@ -1,6 +1,6 @@ # Class: NotificationProvider -[internal](../modules/internal-11.md).NotificationProvider +[internal](../modules/internal-12.md).NotificationProvider ## Properties diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md b/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md new file mode 100644 index 0000000000..e67e08bd46 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostOrderEditsEditLineItemsLineItemReq + +[internal](../modules/internal-13.md).AdminPostOrderEditsEditLineItemsLineItemReq + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/order-edits/update-order-edit-line-item.d.ts:58 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md b/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md new file mode 100644 index 0000000000..04cc6267b3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostOrderEditsEditLineItemsReq + +[internal](../modules/internal-13.md).AdminPostOrderEditsEditLineItemsReq + +## Properties + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:59 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:58 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsOrderEditReq.md b/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsOrderEditReq.md new file mode 100644 index 0000000000..03731526a0 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsOrderEditReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostOrderEditsOrderEditReq + +[internal](../modules/internal-13.md).AdminPostOrderEditsOrderEditReq + +## Properties + +### internal\_note + +• `Optional` **internal\_note**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/order-edits/update-order-edit.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsReq.md b/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsReq.md new file mode 100644 index 0000000000..ac562159fc --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostOrderEditsReq + +[internal](../modules/internal-13.md).AdminPostOrderEditsReq + +## Properties + +### internal\_note + +• `Optional` **internal\_note**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:56 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:55 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal-13.AdminPostPriceListPricesPricesReq.md deleted file mode 100644 index adbe6a4ee7..0000000000 --- a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListPricesPricesReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostPriceListPricesPricesReq - -[internal](../modules/internal-13.md).AdminPostPriceListPricesPricesReq - -## Properties - -### override - -• `Optional` **override**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:66 - -___ - -### prices - -• **prices**: [`AdminPriceListPricesUpdateReq`](internal-13.AdminPriceListPricesUpdateReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:65 diff --git a/docs/content/references/js-client/classes/internal-12.AdditionalItem-1.md b/docs/content/references/js-client/classes/internal-14.AdditionalItem-1.md similarity index 50% rename from docs/content/references/js-client/classes/internal-12.AdditionalItem-1.md rename to docs/content/references/js-client/classes/internal-14.AdditionalItem-1.md index e307fdc296..4e1ad57577 100644 --- a/docs/content/references/js-client/classes/internal-12.AdditionalItem-1.md +++ b/docs/content/references/js-client/classes/internal-14.AdditionalItem-1.md @@ -1,6 +1,6 @@ # Class: AdditionalItem -[internal](../modules/internal-12.md).AdditionalItem +[internal](../modules/internal-14.md).AdditionalItem ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:155 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:204 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:154 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:203 diff --git a/docs/content/references/js-client/classes/internal-12.AdditionalItem.md b/docs/content/references/js-client/classes/internal-14.AdditionalItem.md similarity index 50% rename from docs/content/references/js-client/classes/internal-12.AdditionalItem.md rename to docs/content/references/js-client/classes/internal-14.AdditionalItem.md index 09c0d636e1..8baadd9e1b 100644 --- a/docs/content/references/js-client/classes/internal-12.AdditionalItem.md +++ b/docs/content/references/js-client/classes/internal-14.AdditionalItem.md @@ -1,6 +1,6 @@ # Class: AdditionalItem -[internal](../modules/internal-12.md).AdditionalItem +[internal](../modules/internal-14.md).AdditionalItem ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:121 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:168 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:120 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:167 diff --git a/docs/content/references/js-client/classes/internal-12.AdminGetOrdersParams.md b/docs/content/references/js-client/classes/internal-14.AdminGetOrdersParams.md similarity index 54% rename from docs/content/references/js-client/classes/internal-12.AdminGetOrdersParams.md rename to docs/content/references/js-client/classes/internal-14.AdminGetOrdersParams.md index e140a33a82..f0500d39f6 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminGetOrdersParams.md +++ b/docs/content/references/js-client/classes/internal-14.AdminGetOrdersParams.md @@ -1,10 +1,10 @@ # Class: AdminGetOrdersParams -[internal](../modules/internal-12.md).AdminGetOrdersParams +[internal](../modules/internal-14.md).AdminGetOrdersParams ## Hierarchy -- [`AdminListOrdersSelector`](internal-12.AdminListOrdersSelector.md) +- [`AdminListOrdersSelector`](internal-14.AdminListOrdersSelector.md) ↳ **`AdminGetOrdersParams`** @@ -16,7 +16,7 @@ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[canceled_at](internal-12.AdminListOrdersSelector.md#canceled_at) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[canceled_at](internal-14.AdminListOrdersSelector.md#canceled_at) #### Defined in @@ -30,7 +30,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[cart_id](internal-12.AdminListOrdersSelector.md#cart_id) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[cart_id](internal-14.AdminListOrdersSelector.md#cart_id) #### Defined in @@ -44,7 +44,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[created_at](internal-12.AdminListOrdersSelector.md#created_at) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[created_at](internal-14.AdminListOrdersSelector.md#created_at) #### Defined in @@ -58,7 +58,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[currency_code](internal-12.AdminListOrdersSelector.md#currency_code) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[currency_code](internal-14.AdminListOrdersSelector.md#currency_code) #### Defined in @@ -72,7 +72,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[customer_id](internal-12.AdminListOrdersSelector.md#customer_id) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[customer_id](internal-14.AdminListOrdersSelector.md#customer_id) #### Defined in @@ -86,7 +86,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[display_id](internal-12.AdminListOrdersSelector.md#display_id) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[display_id](internal-14.AdminListOrdersSelector.md#display_id) #### Defined in @@ -100,7 +100,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[email](internal-12.AdminListOrdersSelector.md#email) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[email](internal-14.AdminListOrdersSelector.md#email) #### Defined in @@ -114,7 +114,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/list-orders.d.ts:177 +medusa/dist/api/routes/admin/orders/list-orders.d.ts:208 ___ @@ -124,7 +124,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/list-orders.d.ts:178 +medusa/dist/api/routes/admin/orders/list-orders.d.ts:209 ___ @@ -134,7 +134,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[fulfillment_status](internal-12.AdminListOrdersSelector.md#fulfillment_status) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[fulfillment_status](internal-14.AdminListOrdersSelector.md#fulfillment_status) #### Defined in @@ -148,7 +148,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[id](internal-12.AdminListOrdersSelector.md#id) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[id](internal-14.AdminListOrdersSelector.md#id) #### Defined in @@ -162,7 +162,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/list-orders.d.ts:176 +medusa/dist/api/routes/admin/orders/list-orders.d.ts:207 ___ @@ -172,7 +172,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/list-orders.d.ts:175 +medusa/dist/api/routes/admin/orders/list-orders.d.ts:206 ___ @@ -182,7 +182,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[payment_status](internal-12.AdminListOrdersSelector.md#payment_status) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[payment_status](internal-14.AdminListOrdersSelector.md#payment_status) #### Defined in @@ -196,7 +196,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[q](internal-12.AdminListOrdersSelector.md#q) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[q](internal-14.AdminListOrdersSelector.md#q) #### Defined in @@ -210,7 +210,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[region_id](internal-12.AdminListOrdersSelector.md#region_id) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[region_id](internal-14.AdminListOrdersSelector.md#region_id) #### Defined in @@ -224,7 +224,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[sales_channel_id](internal-12.AdminListOrdersSelector.md#sales_channel_id) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[sales_channel_id](internal-14.AdminListOrdersSelector.md#sales_channel_id) #### Defined in @@ -238,7 +238,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[status](internal-12.AdminListOrdersSelector.md#status) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[status](internal-14.AdminListOrdersSelector.md#status) #### Defined in @@ -252,7 +252,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[tax_rate](internal-12.AdminListOrdersSelector.md#tax_rate) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[tax_rate](internal-14.AdminListOrdersSelector.md#tax_rate) #### Defined in @@ -266,7 +266,7 @@ ___ #### Inherited from -[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[updated_at](internal-12.AdminListOrdersSelector.md#updated_at) +[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[updated_at](internal-14.AdminListOrdersSelector.md#updated_at) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-12.AdminListOrdersSelector.md b/docs/content/references/js-client/classes/internal-14.AdminListOrdersSelector.md similarity index 94% rename from docs/content/references/js-client/classes/internal-12.AdminListOrdersSelector.md rename to docs/content/references/js-client/classes/internal-14.AdminListOrdersSelector.md index b7851a4dc7..98b362a216 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminListOrdersSelector.md +++ b/docs/content/references/js-client/classes/internal-14.AdminListOrdersSelector.md @@ -1,12 +1,12 @@ # Class: AdminListOrdersSelector -[internal](../modules/internal-12.md).AdminListOrdersSelector +[internal](../modules/internal-14.md).AdminListOrdersSelector ## Hierarchy - **`AdminListOrdersSelector`** - ↳ [`AdminGetOrdersParams`](internal-12.AdminGetOrdersParams.md) + ↳ [`AdminGetOrdersParams`](internal-14.AdminGetOrdersParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md similarity index 60% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md index ee5f0f569d..adf80a68c9 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostOrdersOrderClaimsClaimFulfillmentsReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderClaimsClaimFulfillmentsReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimFulfillmentsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:36 +medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:67 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:37 +medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md similarity index 51% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md index 749afeb51a..b10dcc7508 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md @@ -1,16 +1,16 @@ # Class: AdminPostOrdersOrderClaimsClaimReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderClaimsClaimReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimReq ## Properties ### claim\_items -• `Optional` **claim\_items**: [`Item`](internal-12.Item-2.md)[] +• `Optional` **claim\_items**: [`Item`](internal-14.Item-2.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:106 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:143 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:109 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:146 ___ @@ -30,14 +30,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:108 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:145 ___ ### shipping\_methods -• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-12.ShippingMethod-2.md)[] +• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-14.ShippingMethod-2.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:107 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:144 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md similarity index 56% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md index cd5033d8b9..cd67427abd 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostOrdersOrderClaimsClaimShipmentsReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderClaimsClaimShipmentsReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimShipmentsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:40 +medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:77 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:41 +medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:78 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsReq.md similarity index 52% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsReq.md index 1726f01894..1c5ec34400 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsReq.md @@ -1,36 +1,36 @@ # Class: AdminPostOrdersOrderClaimsReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderClaimsReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsReq ## Properties ### additional\_items -• `Optional` **additional\_items**: [`AdditionalItem`](internal-12.AdditionalItem-1.md)[] +• `Optional` **additional\_items**: [`AdditionalItem`](internal-14.AdditionalItem-1.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:129 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:178 ___ ### claim\_items -• **claim\_items**: [`Item`](internal-12.Item-1.md)[] +• **claim\_items**: [`Item`](internal-14.Item-1.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:127 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:176 ___ ### metadata -• `Optional` **metadata**: `object` +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:134 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:183 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:133 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:182 ___ @@ -50,17 +50,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:131 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:180 ___ ### return\_shipping -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-12.ReturnShipping-2.md) +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping-2.md) #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:128 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:177 ___ @@ -70,17 +70,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:132 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:181 ___ ### shipping\_methods -• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-12.ShippingMethod-1.md)[] +• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-14.ShippingMethod-1.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:130 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:179 ___ @@ -90,4 +90,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:126 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:175 diff --git a/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md new file mode 100644 index 0000000000..b83f1fa1b3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostOrdersOrderFulfillmentsReq + +[internal](../modules/internal-14.md).AdminPostOrdersOrderFulfillmentsReq + +## Properties + +### items + +• **items**: [`Item`](internal-14.Item.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:98 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:100 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderRefundsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderRefundsReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderRefundsReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderRefundsReq.md index dedfc2ed96..eebd16b30f 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderRefundsReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderRefundsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostOrdersOrderRefundsReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderRefundsReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderRefundsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/refund-payment.d.ts:44 +medusa/dist/api/routes/admin/orders/refund-payment.d.ts:83 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/refund-payment.d.ts:47 +medusa/dist/api/routes/admin/orders/refund-payment.d.ts:86 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/refund-payment.d.ts:46 +medusa/dist/api/routes/admin/orders/refund-payment.d.ts:85 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/refund-payment.d.ts:45 +medusa/dist/api/routes/admin/orders/refund-payment.d.ts:84 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReq.md similarity index 60% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReq.md index bc3c77d887..f1c3c6a648 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReq.md @@ -1,6 +1,6 @@ # Class: AdminPostOrdersOrderReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:92 +medusa/dist/api/routes/admin/orders/update-order.d.ts:129 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:97 +medusa/dist/api/routes/admin/orders/update-order.d.ts:134 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:96 +medusa/dist/api/routes/admin/orders/update-order.d.ts:133 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:91 +medusa/dist/api/routes/admin/orders/update-order.d.ts:128 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:94 +medusa/dist/api/routes/admin/orders/update-order.d.ts:131 ___ @@ -60,17 +60,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:100 +medusa/dist/api/routes/admin/orders/update-order.d.ts:137 ___ ### payment\_method -• `Optional` **payment\_method**: [`PaymentMethod`](internal-12.PaymentMethod.md) +• `Optional` **payment\_method**: [`PaymentMethod`](internal-14.PaymentMethod.md) #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:98 +medusa/dist/api/routes/admin/orders/update-order.d.ts:135 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:95 +medusa/dist/api/routes/admin/orders/update-order.d.ts:132 ___ @@ -90,14 +90,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:93 +medusa/dist/api/routes/admin/orders/update-order.d.ts:130 ___ ### shipping\_method -• `Optional` **shipping\_method**: [`ShippingMethod`](internal-12.ShippingMethod.md)[] +• `Optional` **shipping\_method**: [`ShippingMethod`](internal-14.ShippingMethod.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:99 +medusa/dist/api/routes/admin/orders/update-order.d.ts:136 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReturnsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReturnsReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReturnsReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReturnsReq.md index da536e87f2..f1e0af5dc1 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReturnsReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReturnsReq.md @@ -1,16 +1,16 @@ # Class: AdminPostOrdersOrderReturnsReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderReturnsReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderReturnsReq ## Properties ### items -• **items**: [`OrdersReturnItem`](internal-12.OrdersReturnItem.md)[] +• **items**: [`OrdersReturnItem`](internal-14.OrdersReturnItem.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/request-return.d.ts:76 +medusa/dist/api/routes/admin/orders/request-return.d.ts:123 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/request-return.d.ts:80 +medusa/dist/api/routes/admin/orders/request-return.d.ts:127 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/request-return.d.ts:78 +medusa/dist/api/routes/admin/orders/request-return.d.ts:125 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/request-return.d.ts:79 +medusa/dist/api/routes/admin/orders/request-return.d.ts:126 ___ @@ -50,14 +50,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/request-return.d.ts:81 +medusa/dist/api/routes/admin/orders/request-return.d.ts:128 ___ ### return\_shipping -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-12.ReturnShipping.md) +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping.md) #### Defined in -medusa/dist/api/routes/admin/orders/request-return.d.ts:77 +medusa/dist/api/routes/admin/orders/request-return.d.ts:124 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShipmentReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShipmentReq.md similarity index 57% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShipmentReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShipmentReq.md index c7830193ad..bf0b690d95 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShipmentReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShipmentReq.md @@ -1,6 +1,6 @@ # Class: AdminPostOrdersOrderShipmentReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderShipmentReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderShipmentReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-shipment.d.ts:42 +medusa/dist/api/routes/admin/orders/create-shipment.d.ts:79 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-shipment.d.ts:44 +medusa/dist/api/routes/admin/orders/create-shipment.d.ts:81 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-shipment.d.ts:43 +medusa/dist/api/routes/admin/orders/create-shipment.d.ts:80 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md index 7f86d4bbcc..96ad1d39a6 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostOrdersOrderShippingMethodsReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderShippingMethodsReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderShippingMethodsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:29 +medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:68 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:28 +medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:67 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:27 +medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:66 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsReq.md similarity index 52% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsReq.md index 0d6f4848b0..a61a760860 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsReq.md @@ -1,16 +1,16 @@ # Class: AdminPostOrdersOrderSwapsReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderSwapsReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsReq ## Properties ### additional\_items -• `Optional` **additional\_items**: [`AdditionalItem`](internal-12.AdditionalItem.md)[] +• `Optional` **additional\_items**: [`AdditionalItem`](internal-14.AdditionalItem.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:100 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:147 ___ @@ -20,17 +20,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:103 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:150 ___ ### custom\_shipping\_options -• `Optional` **custom\_shipping\_options**: [`CustomShippingOption`](internal-12.CustomShippingOption.md)[] +• `Optional` **custom\_shipping\_options**: [`CustomShippingOption`](internal-14.CustomShippingOption.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:101 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:148 ___ @@ -40,24 +40,24 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:102 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:149 ___ ### return\_items -• **return\_items**: [`ReturnItem`](internal-12.ReturnItem.md)[] +• **return\_items**: [`ReturnItem`](internal-14.ReturnItem.md)[] #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:98 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:145 ___ ### return\_shipping -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-12.ReturnShipping-1.md) +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping-1.md) #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:99 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:146 diff --git a/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md new file mode 100644 index 0000000000..87c0c276fc --- /dev/null +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsReq + +[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsSwapFulfillmentsReq + +## Properties + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:67 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md similarity index 57% rename from docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md rename to docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md index b5a76b9cd1..545067fe44 100644 --- a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md +++ b/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostOrdersOrderSwapsSwapShipmentsReq -[internal](../modules/internal-12.md).AdminPostOrdersOrderSwapsSwapShipmentsReq +[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsSwapShipmentsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:43 +medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:80 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:45 +medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:82 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:44 +medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:81 diff --git a/docs/content/references/js-client/classes/internal-14.CustomShippingOption.md b/docs/content/references/js-client/classes/internal-14.CustomShippingOption.md new file mode 100644 index 0000000000..faad121155 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-14.CustomShippingOption.md @@ -0,0 +1,23 @@ +# Class: CustomShippingOption + +[internal](../modules/internal-14.md).CustomShippingOption + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/orders/create-swap.d.ts:163 + +___ + +### price + +• **price**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/orders/create-swap.d.ts:164 diff --git a/docs/content/references/js-client/classes/internal-14.Image.md b/docs/content/references/js-client/classes/internal-14.Image.md new file mode 100644 index 0000000000..d38172f0f8 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-14.Image.md @@ -0,0 +1,23 @@ +# Class: Image + +[internal](../modules/internal-14.md).Image + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/orders/update-claim.d.ts:162 + +___ + +### url + +• `Optional` **url**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/orders/update-claim.d.ts:163 diff --git a/docs/content/references/js-client/classes/internal-12.Item-1.md b/docs/content/references/js-client/classes/internal-14.Item-1.md similarity index 55% rename from docs/content/references/js-client/classes/internal-12.Item-1.md rename to docs/content/references/js-client/classes/internal-14.Item-1.md index d4524473fc..621608b382 100644 --- a/docs/content/references/js-client/classes/internal-12.Item-1.md +++ b/docs/content/references/js-client/classes/internal-14.Item-1.md @@ -1,6 +1,6 @@ # Class: Item -[internal](../modules/internal-12.md).Item +[internal](../modules/internal-14.md).Item ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:151 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:200 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:146 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:195 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:148 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:197 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:147 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:196 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:149 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:198 ___ @@ -60,4 +60,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:150 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:199 diff --git a/docs/content/references/js-client/classes/internal-14.Item-2.md b/docs/content/references/js-client/classes/internal-14.Item-2.md new file mode 100644 index 0000000000..406bccf505 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-14.Item-2.md @@ -0,0 +1,63 @@ +# Class: Item + +[internal](../modules/internal-14.md).Item + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/orders/update-claim.d.ts:154 + +___ + +### images + +• **images**: [`Image`](internal-14.Image.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/orders/update-claim.d.ts:157 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/orders/update-claim.d.ts:159 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/orders/update-claim.d.ts:155 + +___ + +### reason + +• `Optional` **reason**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/orders/update-claim.d.ts:156 + +___ + +### tags + +• **tags**: [`Tag`](internal-14.Tag.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/orders/update-claim.d.ts:158 diff --git a/docs/content/references/js-client/classes/internal-14.Item.md b/docs/content/references/js-client/classes/internal-14.Item.md new file mode 100644 index 0000000000..050e6cf91f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-14.Item.md @@ -0,0 +1,23 @@ +# Class: Item + +[internal](../modules/internal-14.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:103 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:104 diff --git a/docs/content/references/js-client/classes/internal-12.OrdersReturnItem.md b/docs/content/references/js-client/classes/internal-14.OrdersReturnItem.md similarity index 89% rename from docs/content/references/js-client/classes/internal-12.OrdersReturnItem.md rename to docs/content/references/js-client/classes/internal-14.OrdersReturnItem.md index 81ed6aed43..6573dd934d 100644 --- a/docs/content/references/js-client/classes/internal-12.OrdersReturnItem.md +++ b/docs/content/references/js-client/classes/internal-14.OrdersReturnItem.md @@ -1,6 +1,6 @@ # Class: OrdersReturnItem -[internal](../modules/internal-12.md).OrdersReturnItem +[internal](../modules/internal-14.md).OrdersReturnItem ## Properties diff --git a/docs/content/references/js-client/classes/internal-12.PaymentMethod.md b/docs/content/references/js-client/classes/internal-14.PaymentMethod.md similarity index 55% rename from docs/content/references/js-client/classes/internal-12.PaymentMethod.md rename to docs/content/references/js-client/classes/internal-14.PaymentMethod.md index 9f4b3e51cc..e5382857b7 100644 --- a/docs/content/references/js-client/classes/internal-12.PaymentMethod.md +++ b/docs/content/references/js-client/classes/internal-14.PaymentMethod.md @@ -1,6 +1,6 @@ # Class: PaymentMethod -[internal](../modules/internal-12.md).PaymentMethod +[internal](../modules/internal-14.md).PaymentMethod ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:104 +medusa/dist/api/routes/admin/orders/update-order.d.ts:141 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:103 +medusa/dist/api/routes/admin/orders/update-order.d.ts:140 diff --git a/docs/content/references/js-client/classes/internal-12.ReturnItem.md b/docs/content/references/js-client/classes/internal-14.ReturnItem.md similarity index 52% rename from docs/content/references/js-client/classes/internal-12.ReturnItem.md rename to docs/content/references/js-client/classes/internal-14.ReturnItem.md index 5f4f0596bf..5fb71e327c 100644 --- a/docs/content/references/js-client/classes/internal-12.ReturnItem.md +++ b/docs/content/references/js-client/classes/internal-14.ReturnItem.md @@ -1,6 +1,6 @@ # Class: ReturnItem -[internal](../modules/internal-12.md).ReturnItem +[internal](../modules/internal-14.md).ReturnItem ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:106 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:153 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:109 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:156 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:107 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:154 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:108 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:155 diff --git a/docs/content/references/js-client/classes/internal-12.ReturnShipping-1.md b/docs/content/references/js-client/classes/internal-14.ReturnShipping-1.md similarity index 51% rename from docs/content/references/js-client/classes/internal-12.ReturnShipping-1.md rename to docs/content/references/js-client/classes/internal-14.ReturnShipping-1.md index 495d31e2f6..d89795baa6 100644 --- a/docs/content/references/js-client/classes/internal-12.ReturnShipping-1.md +++ b/docs/content/references/js-client/classes/internal-14.ReturnShipping-1.md @@ -1,6 +1,6 @@ # Class: ReturnShipping -[internal](../modules/internal-12.md).ReturnShipping +[internal](../modules/internal-14.md).ReturnShipping ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:112 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:159 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-swap.d.ts:113 +medusa/dist/api/routes/admin/orders/create-swap.d.ts:160 diff --git a/docs/content/references/js-client/classes/internal-12.ReturnShipping-2.md b/docs/content/references/js-client/classes/internal-14.ReturnShipping-2.md similarity index 52% rename from docs/content/references/js-client/classes/internal-12.ReturnShipping-2.md rename to docs/content/references/js-client/classes/internal-14.ReturnShipping-2.md index 40c91f8b34..316389a048 100644 --- a/docs/content/references/js-client/classes/internal-12.ReturnShipping-2.md +++ b/docs/content/references/js-client/classes/internal-14.ReturnShipping-2.md @@ -1,6 +1,6 @@ # Class: ReturnShipping -[internal](../modules/internal-12.md).ReturnShipping +[internal](../modules/internal-14.md).ReturnShipping ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:137 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:186 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:138 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:187 diff --git a/docs/content/references/js-client/classes/internal-12.ReturnShipping.md b/docs/content/references/js-client/classes/internal-14.ReturnShipping.md similarity index 51% rename from docs/content/references/js-client/classes/internal-12.ReturnShipping.md rename to docs/content/references/js-client/classes/internal-14.ReturnShipping.md index 1b23ab4dde..4bc9ab4b3f 100644 --- a/docs/content/references/js-client/classes/internal-12.ReturnShipping.md +++ b/docs/content/references/js-client/classes/internal-14.ReturnShipping.md @@ -1,6 +1,6 @@ # Class: ReturnShipping -[internal](../modules/internal-12.md).ReturnShipping +[internal](../modules/internal-14.md).ReturnShipping ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/request-return.d.ts:84 +medusa/dist/api/routes/admin/orders/request-return.d.ts:131 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/request-return.d.ts:85 +medusa/dist/api/routes/admin/orders/request-return.d.ts:132 diff --git a/docs/content/references/js-client/classes/internal-12.ShippingMethod-1.md b/docs/content/references/js-client/classes/internal-14.ShippingMethod-1.md similarity index 52% rename from docs/content/references/js-client/classes/internal-12.ShippingMethod-1.md rename to docs/content/references/js-client/classes/internal-14.ShippingMethod-1.md index 248f51e220..4daff51048 100644 --- a/docs/content/references/js-client/classes/internal-12.ShippingMethod-1.md +++ b/docs/content/references/js-client/classes/internal-14.ShippingMethod-1.md @@ -1,6 +1,6 @@ # Class: ShippingMethod -[internal](../modules/internal-12.md).ShippingMethod +[internal](../modules/internal-14.md).ShippingMethod ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:141 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:190 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:142 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:191 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/create-claim.d.ts:143 +medusa/dist/api/routes/admin/orders/create-claim.d.ts:192 diff --git a/docs/content/references/js-client/classes/internal-12.ShippingMethod-2.md b/docs/content/references/js-client/classes/internal-14.ShippingMethod-2.md similarity index 52% rename from docs/content/references/js-client/classes/internal-12.ShippingMethod-2.md rename to docs/content/references/js-client/classes/internal-14.ShippingMethod-2.md index e907b12789..945a40d7b3 100644 --- a/docs/content/references/js-client/classes/internal-12.ShippingMethod-2.md +++ b/docs/content/references/js-client/classes/internal-14.ShippingMethod-2.md @@ -1,6 +1,6 @@ # Class: ShippingMethod -[internal](../modules/internal-12.md).ShippingMethod +[internal](../modules/internal-14.md).ShippingMethod ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:112 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:149 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:113 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:150 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:114 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:151 diff --git a/docs/content/references/js-client/classes/internal-12.ShippingMethod.md b/docs/content/references/js-client/classes/internal-14.ShippingMethod.md similarity index 57% rename from docs/content/references/js-client/classes/internal-12.ShippingMethod.md rename to docs/content/references/js-client/classes/internal-14.ShippingMethod.md index 5ce4d68ce5..9aa6d785f3 100644 --- a/docs/content/references/js-client/classes/internal-12.ShippingMethod.md +++ b/docs/content/references/js-client/classes/internal-14.ShippingMethod.md @@ -1,6 +1,6 @@ # Class: ShippingMethod -[internal](../modules/internal-12.md).ShippingMethod +[internal](../modules/internal-14.md).ShippingMethod ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:110 +medusa/dist/api/routes/admin/orders/update-order.d.ts:147 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:111 +medusa/dist/api/routes/admin/orders/update-order.d.ts:148 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:109 +medusa/dist/api/routes/admin/orders/update-order.d.ts:146 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:108 +medusa/dist/api/routes/admin/orders/update-order.d.ts:145 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-order.d.ts:107 +medusa/dist/api/routes/admin/orders/update-order.d.ts:144 diff --git a/docs/content/references/js-client/classes/internal-12.Tag.md b/docs/content/references/js-client/classes/internal-14.Tag.md similarity index 50% rename from docs/content/references/js-client/classes/internal-12.Tag.md rename to docs/content/references/js-client/classes/internal-14.Tag.md index ceb4a42be6..2ba26fff1b 100644 --- a/docs/content/references/js-client/classes/internal-12.Tag.md +++ b/docs/content/references/js-client/classes/internal-14.Tag.md @@ -1,6 +1,6 @@ # Class: Tag -[internal](../modules/internal-12.md).Tag +[internal](../modules/internal-14.md).Tag ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:129 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:166 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/orders/update-claim.d.ts:130 +medusa/dist/api/routes/admin/orders/update-claim.d.ts:167 diff --git a/docs/content/references/js-client/classes/internal-13.AdminDeletePriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal-15.AdminDeletePriceListPricesPricesReq.md similarity index 74% rename from docs/content/references/js-client/classes/internal-13.AdminDeletePriceListPricesPricesReq.md rename to docs/content/references/js-client/classes/internal-15.AdminDeletePriceListPricesPricesReq.md index e7ee68e389..88bbf62f0e 100644 --- a/docs/content/references/js-client/classes/internal-13.AdminDeletePriceListPricesPricesReq.md +++ b/docs/content/references/js-client/classes/internal-15.AdminDeletePriceListPricesPricesReq.md @@ -1,6 +1,6 @@ # Class: AdminDeletePriceListPricesPricesReq -[internal](../modules/internal-13.md).AdminDeletePriceListPricesPricesReq +[internal](../modules/internal-15.md).AdminDeletePriceListPricesPricesReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts:45 +medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts:86 diff --git a/docs/content/references/js-client/classes/internal-13.AdminGetPriceListPaginationParams.md b/docs/content/references/js-client/classes/internal-15.AdminGetPriceListPaginationParams.md similarity index 62% rename from docs/content/references/js-client/classes/internal-13.AdminGetPriceListPaginationParams.md rename to docs/content/references/js-client/classes/internal-15.AdminGetPriceListPaginationParams.md index 972cdd8a5b..9f7ce2151a 100644 --- a/docs/content/references/js-client/classes/internal-13.AdminGetPriceListPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-15.AdminGetPriceListPaginationParams.md @@ -1,10 +1,10 @@ # Class: AdminGetPriceListPaginationParams -[internal](../modules/internal-13.md).AdminGetPriceListPaginationParams +[internal](../modules/internal-15.md).AdminGetPriceListPaginationParams ## Hierarchy -- [`FilterablePriceListProps`](internal-13.FilterablePriceListProps.md) +- [`FilterablePriceListProps`](internal-15.FilterablePriceListProps.md) ↳ **`AdminGetPriceListPaginationParams`** @@ -16,7 +16,7 @@ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[created_at](internal-13.FilterablePriceListProps.md#created_at) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[created_at](internal-15.FilterablePriceListProps.md#created_at) #### Defined in @@ -30,7 +30,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[customer_groups](internal-13.FilterablePriceListProps.md#customer_groups) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[customer_groups](internal-15.FilterablePriceListProps.md#customer_groups) #### Defined in @@ -44,7 +44,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[deleted_at](internal-13.FilterablePriceListProps.md#deleted_at) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[deleted_at](internal-15.FilterablePriceListProps.md#deleted_at) #### Defined in @@ -58,7 +58,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[description](internal-13.FilterablePriceListProps.md#description) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[description](internal-15.FilterablePriceListProps.md#description) #### Defined in @@ -72,7 +72,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:140 +medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:171 ___ @@ -82,7 +82,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[id](internal-13.FilterablePriceListProps.md#id) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[id](internal-15.FilterablePriceListProps.md#id) #### Defined in @@ -96,7 +96,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:139 +medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:170 ___ @@ -106,7 +106,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[name](internal-13.FilterablePriceListProps.md#name) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[name](internal-15.FilterablePriceListProps.md#name) #### Defined in @@ -120,7 +120,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:138 +medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:169 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:141 +medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:172 ___ @@ -140,7 +140,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[q](internal-13.FilterablePriceListProps.md#q) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[q](internal-15.FilterablePriceListProps.md#q) #### Defined in @@ -154,7 +154,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[status](internal-13.FilterablePriceListProps.md#status) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[status](internal-15.FilterablePriceListProps.md#status) #### Defined in @@ -168,7 +168,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[type](internal-13.FilterablePriceListProps.md#type) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[type](internal-15.FilterablePriceListProps.md#type) #### Defined in @@ -182,7 +182,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[updated_at](internal-13.FilterablePriceListProps.md#updated_at) +[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[updated_at](internal-15.FilterablePriceListProps.md#updated_at) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-13.AdminGetPriceListsPriceListProductsParams.md b/docs/content/references/js-client/classes/internal-15.AdminGetPriceListsPriceListProductsParams.md similarity index 89% rename from docs/content/references/js-client/classes/internal-13.AdminGetPriceListsPriceListProductsParams.md rename to docs/content/references/js-client/classes/internal-15.AdminGetPriceListsPriceListProductsParams.md index 0868799258..c2956a0361 100644 --- a/docs/content/references/js-client/classes/internal-13.AdminGetPriceListsPriceListProductsParams.md +++ b/docs/content/references/js-client/classes/internal-15.AdminGetPriceListsPriceListProductsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetPriceListsPriceListProductsParams -[internal](../modules/internal-13.md).AdminGetPriceListsPriceListProductsParams +[internal](../modules/internal-15.md).AdminGetPriceListsPriceListProductsParams ## Hierarchy -- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-13.md#admingetpricelistspricelistproductsparams_base) +- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-15.md#admingetpricelistspricelistproductsparams_base) ↳ **`AdminGetPriceListsPriceListProductsParams`** @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:148 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:179 ___ @@ -26,7 +26,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:156 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:187 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:158 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:189 ___ @@ -46,7 +46,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:151 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:182 ___ @@ -60,7 +60,7 @@ AdminGetPriceListsPriceListProductsParams\_base.expand #### Defined in -medusa/dist/types/common.d.ts:116 +medusa/dist/types/common.d.ts:117 ___ @@ -74,7 +74,7 @@ AdminGetPriceListsPriceListProductsParams\_base.fields #### Defined in -medusa/dist/types/common.d.ts:117 +medusa/dist/types/common.d.ts:118 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:152 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:183 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:145 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:176 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:153 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:184 ___ @@ -118,7 +118,7 @@ AdminGetPriceListsPriceListProductsParams\_base.limit #### Defined in -medusa/dist/types/common.d.ts:121 +medusa/dist/types/common.d.ts:122 ___ @@ -132,7 +132,7 @@ AdminGetPriceListsPriceListProductsParams\_base.offset #### Defined in -medusa/dist/types/common.d.ts:120 +medusa/dist/types/common.d.ts:121 ___ @@ -142,7 +142,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:155 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:186 ___ @@ -152,7 +152,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:146 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:177 ___ @@ -162,7 +162,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:147 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:178 ___ @@ -172,7 +172,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:149 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:180 ___ @@ -182,7 +182,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:150 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:181 ___ @@ -192,7 +192,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:154 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:185 ___ @@ -202,4 +202,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:157 +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:188 diff --git a/docs/content/references/js-client/classes/internal-15.AdminPostPriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal-15.AdminPostPriceListPricesPricesReq.md new file mode 100644 index 0000000000..2f3c1d6087 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-15.AdminPostPriceListPricesPricesReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostPriceListPricesPricesReq + +[internal](../modules/internal-15.md).AdminPostPriceListPricesPricesReq + +## Properties + +### override + +• `Optional` **override**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:115 + +___ + +### prices + +• **prices**: [`AdminPriceListPricesUpdateReq`](internal-15.AdminPriceListPricesUpdateReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:114 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md b/docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md similarity index 80% rename from docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md rename to docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md index 22ec02db17..d991fc57c4 100644 --- a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md +++ b/docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md @@ -1,16 +1,16 @@ # Class: AdminPostPriceListsPriceListPriceListReq -[internal](../modules/internal-13.md).AdminPostPriceListsPriceListPriceListReq +[internal](../modules/internal-15.md).AdminPostPriceListsPriceListPriceListReq ## Properties ### customer\_groups -• `Optional` **customer\_groups**: [`CustomerGroup`](internal-13.CustomerGroup-1.md)[] +• `Optional` **customer\_groups**: [`CustomerGroup`](internal-15.CustomerGroup-1.md)[] #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:108 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:148 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:102 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:142 ___ @@ -30,7 +30,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:104 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:144 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:149 ___ @@ -40,17 +50,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:101 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:141 ___ ### prices -• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-13.AdminPriceListPricesUpdateReq.md)[] +• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-15.AdminPriceListPricesUpdateReq.md)[] #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:107 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:147 ___ @@ -60,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:103 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:143 ___ @@ -70,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:105 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:145 ___ @@ -80,4 +90,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:106 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:146 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListReq.md b/docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListReq.md similarity index 78% rename from docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListReq.md rename to docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListReq.md index 9b7c3fa59d..3e4eb2a9ac 100644 --- a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListReq.md +++ b/docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListReq.md @@ -1,16 +1,16 @@ # Class: AdminPostPriceListsPriceListReq -[internal](../modules/internal-13.md).AdminPostPriceListsPriceListReq +[internal](../modules/internal-15.md).AdminPostPriceListsPriceListReq ## Properties ### customer\_groups -• `Optional` **customer\_groups**: [`CustomerGroup`](internal-13.CustomerGroup.md)[] +• `Optional` **customer\_groups**: [`CustomerGroup`](internal-15.CustomerGroup.md)[] #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:109 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:168 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:103 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:162 ___ @@ -30,7 +30,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:105 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:164 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:169 ___ @@ -40,17 +50,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:102 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:161 ___ ### prices -• **prices**: [`AdminPriceListPricesCreateReq`](internal-13.AdminPriceListPricesCreateReq.md)[] +• **prices**: [`AdminPriceListPricesCreateReq`](internal-15.AdminPriceListPricesCreateReq.md)[] #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:108 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:167 ___ @@ -60,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:104 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:163 ___ @@ -70,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:106 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:165 ___ @@ -80,4 +90,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:107 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:166 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPriceListPricesCreateReq.md b/docs/content/references/js-client/classes/internal-15.AdminPriceListPricesCreateReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-13.AdminPriceListPricesCreateReq.md rename to docs/content/references/js-client/classes/internal-15.AdminPriceListPricesCreateReq.md index beea806bec..9506907704 100644 --- a/docs/content/references/js-client/classes/internal-13.AdminPriceListPricesCreateReq.md +++ b/docs/content/references/js-client/classes/internal-15.AdminPriceListPricesCreateReq.md @@ -1,6 +1,6 @@ # Class: AdminPriceListPricesCreateReq -[internal](../modules/internal-13.md).AdminPriceListPricesCreateReq +[internal](../modules/internal-15.md).AdminPriceListPricesCreateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-13.AdminPriceListPricesUpdateReq.md b/docs/content/references/js-client/classes/internal-15.AdminPriceListPricesUpdateReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-13.AdminPriceListPricesUpdateReq.md rename to docs/content/references/js-client/classes/internal-15.AdminPriceListPricesUpdateReq.md index 355969312e..a11af6eec8 100644 --- a/docs/content/references/js-client/classes/internal-13.AdminPriceListPricesUpdateReq.md +++ b/docs/content/references/js-client/classes/internal-15.AdminPriceListPricesUpdateReq.md @@ -1,6 +1,6 @@ # Class: AdminPriceListPricesUpdateReq -[internal](../modules/internal-13.md).AdminPriceListPricesUpdateReq +[internal](../modules/internal-15.md).AdminPriceListPricesUpdateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-13.CustomerGroup-1.md b/docs/content/references/js-client/classes/internal-15.CustomerGroup-1.md similarity index 72% rename from docs/content/references/js-client/classes/internal-13.CustomerGroup-1.md rename to docs/content/references/js-client/classes/internal-15.CustomerGroup-1.md index 9dc7309596..94c15b2d21 100644 --- a/docs/content/references/js-client/classes/internal-13.CustomerGroup-1.md +++ b/docs/content/references/js-client/classes/internal-15.CustomerGroup-1.md @@ -1,6 +1,6 @@ # Class: CustomerGroup -[internal](../modules/internal-13.md).CustomerGroup +[internal](../modules/internal-15.md).CustomerGroup ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:98 +medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:138 diff --git a/docs/content/references/js-client/classes/internal-13.CustomerGroup.md b/docs/content/references/js-client/classes/internal-15.CustomerGroup.md similarity index 72% rename from docs/content/references/js-client/classes/internal-13.CustomerGroup.md rename to docs/content/references/js-client/classes/internal-15.CustomerGroup.md index b77b4018ad..d9f35dd43f 100644 --- a/docs/content/references/js-client/classes/internal-13.CustomerGroup.md +++ b/docs/content/references/js-client/classes/internal-15.CustomerGroup.md @@ -1,6 +1,6 @@ # Class: CustomerGroup -[internal](../modules/internal-13.md).CustomerGroup +[internal](../modules/internal-15.md).CustomerGroup ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:99 +medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:158 diff --git a/docs/content/references/js-client/classes/internal-13.FilterablePriceListProps.md b/docs/content/references/js-client/classes/internal-15.FilterablePriceListProps.md similarity index 92% rename from docs/content/references/js-client/classes/internal-13.FilterablePriceListProps.md rename to docs/content/references/js-client/classes/internal-15.FilterablePriceListProps.md index e0ff5016ed..3fd47b32a5 100644 --- a/docs/content/references/js-client/classes/internal-13.FilterablePriceListProps.md +++ b/docs/content/references/js-client/classes/internal-15.FilterablePriceListProps.md @@ -1,12 +1,12 @@ # Class: FilterablePriceListProps -[internal](../modules/internal-13.md).FilterablePriceListProps +[internal](../modules/internal-15.md).FilterablePriceListProps ## Hierarchy - **`FilterablePriceListProps`** - ↳ [`AdminGetPriceListPaginationParams`](internal-13.AdminGetPriceListPaginationParams.md) + ↳ [`AdminGetPriceListPaginationParams`](internal-15.AdminGetPriceListPaginationParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsPaginationParams.md b/docs/content/references/js-client/classes/internal-16.AdminGetProductTagsPaginationParams.md similarity index 73% rename from docs/content/references/js-client/classes/internal-14.AdminGetProductTagsPaginationParams.md rename to docs/content/references/js-client/classes/internal-16.AdminGetProductTagsPaginationParams.md index 2c5cf0b9a7..962d4440c0 100644 --- a/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-16.AdminGetProductTagsPaginationParams.md @@ -1,12 +1,12 @@ # Class: AdminGetProductTagsPaginationParams -[internal](../modules/internal-14.md).AdminGetProductTagsPaginationParams +[internal](../modules/internal-16.md).AdminGetProductTagsPaginationParams ## Hierarchy - **`AdminGetProductTagsPaginationParams`** - ↳ [`AdminGetProductTagsParams`](internal-14.AdminGetProductTagsParams.md) + ↳ [`AdminGetProductTagsParams`](internal-16.AdminGetProductTagsParams.md) ## Properties @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:99 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:130 ___ @@ -26,4 +26,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:100 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:131 diff --git a/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsParams.md b/docs/content/references/js-client/classes/internal-16.AdminGetProductTagsParams.md similarity index 73% rename from docs/content/references/js-client/classes/internal-14.AdminGetProductTagsParams.md rename to docs/content/references/js-client/classes/internal-16.AdminGetProductTagsParams.md index 66738b066a..8accaea227 100644 --- a/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsParams.md +++ b/docs/content/references/js-client/classes/internal-16.AdminGetProductTagsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetProductTagsParams -[internal](../modules/internal-14.md).AdminGetProductTagsParams +[internal](../modules/internal-16.md).AdminGetProductTagsParams ## Hierarchy -- [`AdminGetProductTagsPaginationParams`](internal-14.AdminGetProductTagsPaginationParams.md) +- [`AdminGetProductTagsPaginationParams`](internal-16.AdminGetProductTagsPaginationParams.md) ↳ **`AdminGetProductTagsParams`** @@ -16,17 +16,17 @@ #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:106 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:137 ___ ### id -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:103 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:134 ___ @@ -36,11 +36,11 @@ ___ #### Inherited from -[AdminGetProductTagsPaginationParams](internal-14.AdminGetProductTagsPaginationParams.md).[limit](internal-14.AdminGetProductTagsPaginationParams.md#limit) +[AdminGetProductTagsPaginationParams](internal-16.AdminGetProductTagsPaginationParams.md).[limit](internal-16.AdminGetProductTagsPaginationParams.md#limit) #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:99 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:130 ___ @@ -50,11 +50,11 @@ ___ #### Inherited from -[AdminGetProductTagsPaginationParams](internal-14.AdminGetProductTagsPaginationParams.md).[offset](internal-14.AdminGetProductTagsPaginationParams.md#offset) +[AdminGetProductTagsPaginationParams](internal-16.AdminGetProductTagsPaginationParams.md).[offset](internal-16.AdminGetProductTagsPaginationParams.md#offset) #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:100 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:131 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:108 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:139 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:104 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:135 ___ @@ -84,14 +84,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:107 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:138 ___ ### value -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) #### Defined in -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:105 +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:136 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductMetadataReq.md b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductMetadataReq.md deleted file mode 100644 index bcb381322a..0000000000 --- a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductMetadataReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostProductsProductMetadataReq - -[internal](../modules/internal-16.md).AdminPostProductsProductMetadataReq - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/set-metadata.d.ts:38 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/set-metadata.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-16.ProductOptionReq.md b/docs/content/references/js-client/classes/internal-16.ProductOptionReq.md deleted file mode 100644 index 0997bc24f0..0000000000 --- a/docs/content/references/js-client/classes/internal-16.ProductOptionReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ProductOptionReq - -[internal](../modules/internal-16.md).ProductOptionReq - -## Properties - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:235 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-1.md b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-1.md deleted file mode 100644 index d0491043c9..0000000000 --- a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-1.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ProductVariantOptionReq - -[internal](../modules/internal-16.md).ProductVariantOptionReq - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:123 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:122 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-2.md b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-2.md deleted file mode 100644 index f9cfe05fb7..0000000000 --- a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-2.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ProductVariantOptionReq - -[internal](../modules/internal-16.md).ProductVariantOptionReq - -## Properties - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:232 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-3.md b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-3.md deleted file mode 100644 index 9e838e3a22..0000000000 --- a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-3.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ProductVariantOptionReq - -[internal](../modules/internal-16.md).ProductVariantOptionReq - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:221 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:220 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq.md b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq.md deleted file mode 100644 index 6d59f36045..0000000000 --- a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ProductVariantOptionReq - -[internal](../modules/internal-16.md).ProductVariantOptionReq - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:127 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:126 diff --git a/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesPaginationParams.md b/docs/content/references/js-client/classes/internal-17.AdminGetProductTypesPaginationParams.md similarity index 74% rename from docs/content/references/js-client/classes/internal-15.AdminGetProductTypesPaginationParams.md rename to docs/content/references/js-client/classes/internal-17.AdminGetProductTypesPaginationParams.md index de756e24a7..c6cd1ddc03 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-17.AdminGetProductTypesPaginationParams.md @@ -1,12 +1,12 @@ # Class: AdminGetProductTypesPaginationParams -[internal](../modules/internal-15.md).AdminGetProductTypesPaginationParams +[internal](../modules/internal-17.md).AdminGetProductTypesPaginationParams ## Hierarchy - **`AdminGetProductTypesPaginationParams`** - ↳ [`AdminGetProductTypesParams`](internal-15.AdminGetProductTypesParams.md) + ↳ [`AdminGetProductTypesParams`](internal-17.AdminGetProductTypesParams.md) ## Properties @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:99 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:130 ___ @@ -26,4 +26,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:100 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:131 diff --git a/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesParams.md b/docs/content/references/js-client/classes/internal-17.AdminGetProductTypesParams.md similarity index 73% rename from docs/content/references/js-client/classes/internal-15.AdminGetProductTypesParams.md rename to docs/content/references/js-client/classes/internal-17.AdminGetProductTypesParams.md index 723244923b..e6654266c9 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesParams.md +++ b/docs/content/references/js-client/classes/internal-17.AdminGetProductTypesParams.md @@ -1,10 +1,10 @@ # Class: AdminGetProductTypesParams -[internal](../modules/internal-15.md).AdminGetProductTypesParams +[internal](../modules/internal-17.md).AdminGetProductTypesParams ## Hierarchy -- [`AdminGetProductTypesPaginationParams`](internal-15.AdminGetProductTypesPaginationParams.md) +- [`AdminGetProductTypesPaginationParams`](internal-17.AdminGetProductTypesPaginationParams.md) ↳ **`AdminGetProductTypesParams`** @@ -16,17 +16,17 @@ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:106 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:137 ___ ### id -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:103 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:134 ___ @@ -36,11 +36,11 @@ ___ #### Inherited from -[AdminGetProductTypesPaginationParams](internal-15.AdminGetProductTypesPaginationParams.md).[limit](internal-15.AdminGetProductTypesPaginationParams.md#limit) +[AdminGetProductTypesPaginationParams](internal-17.AdminGetProductTypesPaginationParams.md).[limit](internal-17.AdminGetProductTypesPaginationParams.md#limit) #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:99 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:130 ___ @@ -50,11 +50,11 @@ ___ #### Inherited from -[AdminGetProductTypesPaginationParams](internal-15.AdminGetProductTypesPaginationParams.md).[offset](internal-15.AdminGetProductTypesPaginationParams.md#offset) +[AdminGetProductTypesPaginationParams](internal-17.AdminGetProductTypesPaginationParams.md).[offset](internal-17.AdminGetProductTypesPaginationParams.md#offset) #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:100 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:131 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:108 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:139 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:104 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:135 ___ @@ -84,14 +84,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:107 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:138 ___ ### value -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:105 +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:136 diff --git a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md b/docs/content/references/js-client/classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md deleted file mode 100644 index 02aa8d51ae..0000000000 --- a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminGetRegionsRegionFulfillmentOptionsRes - -[internal](../modules/internal-17.md).AdminGetRegionsRegionFulfillmentOptionsRes - -## Properties - -### fulfillment\_options - -• **fulfillment\_options**: [`FulfillmentOption`](internal-17.FulfillmentOption.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/index.d.ts:20 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsReq.md deleted file mode 100644 index d01bafbb79..0000000000 --- a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsReq.md +++ /dev/null @@ -1,83 +0,0 @@ -# Class: AdminPostRegionsReq - -[internal](../modules/internal-17.md).AdminPostRegionsReq - -## Properties - -### countries - -• **countries**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:71 - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:66 - -___ - -### fulfillment\_providers - -• **fulfillment\_providers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:70 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:72 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:65 - -___ - -### payment\_providers - -• **payment\_providers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:69 - -___ - -### tax\_code - -• `Optional` **tax\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:67 - -___ - -### tax\_rate - -• **tax\_rate**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-16.AdminGetProductsParams.md b/docs/content/references/js-client/classes/internal-18.AdminGetProductsParams.md similarity index 54% rename from docs/content/references/js-client/classes/internal-16.AdminGetProductsParams.md rename to docs/content/references/js-client/classes/internal-18.AdminGetProductsParams.md index 93d197d35d..6b7924ddf6 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminGetProductsParams.md +++ b/docs/content/references/js-client/classes/internal-18.AdminGetProductsParams.md @@ -1,12 +1,12 @@ # Class: AdminGetProductsParams -[internal](../modules/internal-16.md).AdminGetProductsParams +[internal](../modules/internal-18.md).AdminGetProductsParams API Level DTOs + Validation rules ## Hierarchy -- [`FilterableProductProps`](internal-16.FilterableProductProps.md) +- [`FilterableProductProps`](internal-18.FilterableProductProps.md) ↳ **`AdminGetProductsParams`** @@ -18,7 +18,7 @@ API Level DTOs + Validation rules #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[collection_id](internal-16.FilterableProductProps.md#collection_id) +[FilterableProductProps](internal-18.FilterableProductProps.md).[collection_id](internal-18.FilterableProductProps.md#collection_id) #### Defined in @@ -32,7 +32,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[created_at](internal-16.FilterableProductProps.md#created_at) +[FilterableProductProps](internal-18.FilterableProductProps.md).[created_at](internal-18.FilterableProductProps.md#created_at) #### Defined in @@ -46,7 +46,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[deleted_at](internal-16.FilterableProductProps.md#deleted_at) +[FilterableProductProps](internal-18.FilterableProductProps.md).[deleted_at](internal-18.FilterableProductProps.md#deleted_at) #### Defined in @@ -60,7 +60,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[description](internal-16.FilterableProductProps.md#description) +[FilterableProductProps](internal-18.FilterableProductProps.md).[description](internal-18.FilterableProductProps.md#description) #### Defined in @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/list-products.d.ts:172 +medusa/dist/api/routes/admin/products/list-products.d.ts:203 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/list-products.d.ts:173 +medusa/dist/api/routes/admin/products/list-products.d.ts:204 ___ @@ -94,7 +94,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[handle](internal-16.FilterableProductProps.md#handle) +[FilterableProductProps](internal-18.FilterableProductProps.md).[handle](internal-18.FilterableProductProps.md#handle) #### Defined in @@ -108,7 +108,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[id](internal-16.FilterableProductProps.md#id) +[FilterableProductProps](internal-18.FilterableProductProps.md).[id](internal-18.FilterableProductProps.md#id) #### Defined in @@ -122,7 +122,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[is_giftcard](internal-16.FilterableProductProps.md#is_giftcard) +[FilterableProductProps](internal-18.FilterableProductProps.md).[is_giftcard](internal-18.FilterableProductProps.md#is_giftcard) #### Defined in @@ -136,7 +136,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/list-products.d.ts:171 +medusa/dist/api/routes/admin/products/list-products.d.ts:202 ___ @@ -146,7 +146,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/list-products.d.ts:170 +medusa/dist/api/routes/admin/products/list-products.d.ts:201 ___ @@ -156,7 +156,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[price_list_id](internal-16.FilterableProductProps.md#price_list_id) +[FilterableProductProps](internal-18.FilterableProductProps.md).[price_list_id](internal-18.FilterableProductProps.md#price_list_id) #### Defined in @@ -170,7 +170,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[q](internal-16.FilterableProductProps.md#q) +[FilterableProductProps](internal-18.FilterableProductProps.md).[q](internal-18.FilterableProductProps.md#q) #### Defined in @@ -184,7 +184,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[sales_channel_id](internal-16.FilterableProductProps.md#sales_channel_id) +[FilterableProductProps](internal-18.FilterableProductProps.md).[sales_channel_id](internal-18.FilterableProductProps.md#sales_channel_id) #### Defined in @@ -198,7 +198,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[status](internal-16.FilterableProductProps.md#status) +[FilterableProductProps](internal-18.FilterableProductProps.md).[status](internal-18.FilterableProductProps.md#status) #### Defined in @@ -212,7 +212,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[tags](internal-16.FilterableProductProps.md#tags) +[FilterableProductProps](internal-18.FilterableProductProps.md).[tags](internal-18.FilterableProductProps.md#tags) #### Defined in @@ -226,7 +226,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[title](internal-16.FilterableProductProps.md#title) +[FilterableProductProps](internal-18.FilterableProductProps.md).[title](internal-18.FilterableProductProps.md#title) #### Defined in @@ -240,7 +240,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[type](internal-16.FilterableProductProps.md#type) +[FilterableProductProps](internal-18.FilterableProductProps.md).[type](internal-18.FilterableProductProps.md#type) #### Defined in @@ -254,7 +254,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-16.FilterableProductProps.md).[updated_at](internal-16.FilterableProductProps.md#updated_at) +[FilterableProductProps](internal-18.FilterableProductProps.md).[updated_at](internal-18.FilterableProductProps.md#updated_at) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductMetadataReq.md b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductMetadataReq.md new file mode 100644 index 0000000000..9b9f815e28 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductMetadataReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostProductsProductMetadataReq + +[internal](../modules/internal-18.md).AdminPostProductsProductMetadataReq + +## Properties + +### key + +• **key**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/set-metadata.d.ts:77 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/set-metadata.d.ts:78 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsOption.md b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsOption.md similarity index 50% rename from docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsOption.md rename to docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsOption.md index 64c440e1a4..349db82079 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsOption.md +++ b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsOption.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductOptionsOption -[internal](../modules/internal-16.md).AdminPostProductsProductOptionsOption +[internal](../modules/internal-18.md).AdminPostProductsProductOptionsOption ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/products/update-option.d.ts:35 +medusa/dist/api/routes/admin/products/update-option.d.ts:72 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsReq.md b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsReq.md rename to docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsReq.md index ed5cf4eca6..1af93a25b2 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsReq.md +++ b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductOptionsReq -[internal](../modules/internal-16.md).AdminPostProductsProductOptionsReq +[internal](../modules/internal-18.md).AdminPostProductsProductOptionsReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/products/add-option.d.ts:34 +medusa/dist/api/routes/admin/products/add-option.d.ts:71 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductReq.md b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductReq.md similarity index 51% rename from docs/content/references/js-client/classes/internal-16.AdminPostProductsProductReq.md rename to docs/content/references/js-client/classes/internal-18.AdminPostProductsProductReq.md index 674cb17777..d3430da5b2 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductReq.md +++ b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductReq -[internal](../modules/internal-16.md).AdminPostProductsProductReq +[internal](../modules/internal-18.md).AdminPostProductsProductReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:255 +medusa/dist/api/routes/admin/products/update-product.d.ts:293 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:248 +medusa/dist/api/routes/admin/products/update-product.d.ts:286 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:249 +medusa/dist/api/routes/admin/products/update-product.d.ts:287 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:252 +medusa/dist/api/routes/admin/products/update-product.d.ts:290 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:261 +medusa/dist/api/routes/admin/products/update-product.d.ts:299 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:263 +medusa/dist/api/routes/admin/products/update-product.d.ts:301 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:250 +medusa/dist/api/routes/admin/products/update-product.d.ts:288 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:260 +medusa/dist/api/routes/admin/products/update-product.d.ts:298 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:266 +medusa/dist/api/routes/admin/products/update-product.d.ts:304 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:267 +medusa/dist/api/routes/admin/products/update-product.d.ts:305 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:265 +medusa/dist/api/routes/admin/products/update-product.d.ts:303 ___ @@ -120,17 +120,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:264 +medusa/dist/api/routes/admin/products/update-product.d.ts:302 ___ ### sales\_channels -• **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-16.ProductSalesChannelReq.md)[] +• **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-18.ProductSalesChannelReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:257 +medusa/dist/api/routes/admin/products/update-product.d.ts:295 ___ @@ -140,7 +140,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:253 +medusa/dist/api/routes/admin/products/update-product.d.ts:291 ___ @@ -150,17 +150,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:247 +medusa/dist/api/routes/admin/products/update-product.d.ts:285 ___ ### tags -• `Optional` **tags**: [`ProductTagReq`](internal-16.ProductTagReq.md)[] +• `Optional` **tags**: [`ProductTagReq`](internal-18.ProductTagReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:256 +medusa/dist/api/routes/admin/products/update-product.d.ts:294 ___ @@ -170,7 +170,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:251 +medusa/dist/api/routes/admin/products/update-product.d.ts:289 ___ @@ -180,27 +180,27 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:246 +medusa/dist/api/routes/admin/products/update-product.d.ts:284 ___ ### type -• `Optional` **type**: [`ProductTypeReq`](internal-16.ProductTypeReq.md) +• `Optional` **type**: [`ProductTypeReq`](internal-18.ProductTypeReq.md) #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:254 +medusa/dist/api/routes/admin/products/update-product.d.ts:292 ___ ### variants -• `Optional` **variants**: [`ProductVariantReq`](internal-16.ProductVariantReq-1.md)[] +• `Optional` **variants**: [`ProductVariantReq`](internal-18.ProductVariantReq-1.md)[] #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:258 +medusa/dist/api/routes/admin/products/update-product.d.ts:296 ___ @@ -210,7 +210,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:259 +medusa/dist/api/routes/admin/products/update-product.d.ts:297 ___ @@ -220,4 +220,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:262 +medusa/dist/api/routes/admin/products/update-product.d.ts:300 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsReq.md b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsReq.md rename to docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsReq.md index 3062a2deaf..1f7d6f0c31 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsReq.md +++ b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductVariantsReq -[internal](../modules/internal-16.md).AdminPostProductsProductVariantsReq +[internal](../modules/internal-18.md).AdminPostProductsProductVariantsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:137 +medusa/dist/api/routes/admin/products/create-variant.d.ts:199 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:134 +medusa/dist/api/routes/admin/products/create-variant.d.ts:196 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:132 +medusa/dist/api/routes/admin/products/create-variant.d.ts:194 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:141 +medusa/dist/api/routes/admin/products/create-variant.d.ts:203 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:135 +medusa/dist/api/routes/admin/products/create-variant.d.ts:197 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:136 +medusa/dist/api/routes/admin/products/create-variant.d.ts:198 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:140 +medusa/dist/api/routes/admin/products/create-variant.d.ts:202 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:138 +medusa/dist/api/routes/admin/products/create-variant.d.ts:200 ___ @@ -90,17 +90,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:145 +medusa/dist/api/routes/admin/products/create-variant.d.ts:207 ___ ### metadata -• `Optional` **metadata**: `object` +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:146 +medusa/dist/api/routes/admin/products/create-variant.d.ts:208 ___ @@ -110,17 +110,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:144 +medusa/dist/api/routes/admin/products/create-variant.d.ts:206 ___ ### options -• **options**: [`ProductVariantOptionReq`](internal-16.ProductVariantOptionReq.md)[] +• **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:148 +medusa/dist/api/routes/admin/products/create-variant.d.ts:210 ___ @@ -130,17 +130,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:143 +medusa/dist/api/routes/admin/products/create-variant.d.ts:205 ___ ### prices -• **prices**: [`ProductVariantPricesCreateReq`](internal-16.ProductVariantPricesCreateReq.md)[] +• **prices**: [`ProductVariantPricesCreateReq`](internal-18.ProductVariantPricesCreateReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:147 +medusa/dist/api/routes/admin/products/create-variant.d.ts:209 ___ @@ -150,7 +150,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:131 +medusa/dist/api/routes/admin/products/create-variant.d.ts:193 ___ @@ -160,7 +160,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:130 +medusa/dist/api/routes/admin/products/create-variant.d.ts:192 ___ @@ -170,7 +170,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:133 +medusa/dist/api/routes/admin/products/create-variant.d.ts:195 ___ @@ -180,7 +180,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:139 +medusa/dist/api/routes/admin/products/create-variant.d.ts:201 ___ @@ -190,4 +190,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-variant.d.ts:142 +medusa/dist/api/routes/admin/products/create-variant.d.ts:204 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsVariantReq.md b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsVariantReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsVariantReq.md rename to docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsVariantReq.md index 722e0ea46d..221949ff6b 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsVariantReq.md +++ b/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsVariantReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductVariantsVariantReq -[internal](../modules/internal-16.md).AdminPostProductsProductVariantsVariantReq +[internal](../modules/internal-18.md).AdminPostProductsProductVariantsVariantReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:133 +medusa/dist/api/routes/admin/products/update-variant.d.ts:191 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:130 +medusa/dist/api/routes/admin/products/update-variant.d.ts:188 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:128 +medusa/dist/api/routes/admin/products/update-variant.d.ts:186 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:137 +medusa/dist/api/routes/admin/products/update-variant.d.ts:195 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:131 +medusa/dist/api/routes/admin/products/update-variant.d.ts:189 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:132 +medusa/dist/api/routes/admin/products/update-variant.d.ts:190 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:136 +medusa/dist/api/routes/admin/products/update-variant.d.ts:194 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:134 +medusa/dist/api/routes/admin/products/update-variant.d.ts:192 ___ @@ -90,17 +90,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:141 +medusa/dist/api/routes/admin/products/update-variant.d.ts:199 ___ ### metadata -• `Optional` **metadata**: `object` +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:142 +medusa/dist/api/routes/admin/products/update-variant.d.ts:200 ___ @@ -110,17 +110,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:140 +medusa/dist/api/routes/admin/products/update-variant.d.ts:198 ___ ### options -• **options**: [`ProductVariantOptionReq`](internal-16.ProductVariantOptionReq-1.md)[] +• **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-1.md)[] #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:144 +medusa/dist/api/routes/admin/products/update-variant.d.ts:202 ___ @@ -130,17 +130,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:139 +medusa/dist/api/routes/admin/products/update-variant.d.ts:197 ___ ### prices -• **prices**: [`ProductVariantPricesUpdateReq`](internal-16.ProductVariantPricesUpdateReq.md)[] +• **prices**: [`ProductVariantPricesUpdateReq`](internal-18.ProductVariantPricesUpdateReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:143 +medusa/dist/api/routes/admin/products/update-variant.d.ts:201 ___ @@ -150,7 +150,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:127 +medusa/dist/api/routes/admin/products/update-variant.d.ts:185 ___ @@ -160,7 +160,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:126 +medusa/dist/api/routes/admin/products/update-variant.d.ts:184 ___ @@ -170,7 +170,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:129 +medusa/dist/api/routes/admin/products/update-variant.d.ts:187 ___ @@ -180,7 +180,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:135 +medusa/dist/api/routes/admin/products/update-variant.d.ts:193 ___ @@ -190,4 +190,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-variant.d.ts:138 +medusa/dist/api/routes/admin/products/update-variant.d.ts:196 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsReq.md b/docs/content/references/js-client/classes/internal-18.AdminPostProductsReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal-16.AdminPostProductsReq.md rename to docs/content/references/js-client/classes/internal-18.AdminPostProductsReq.md index 7caa9b3f93..40af080321 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminPostProductsReq.md +++ b/docs/content/references/js-client/classes/internal-18.AdminPostProductsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsReq -[internal](../modules/internal-16.md).AdminPostProductsReq +[internal](../modules/internal-18.md).AdminPostProductsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:269 +medusa/dist/api/routes/admin/products/create-product.d.ts:308 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:261 +medusa/dist/api/routes/admin/products/create-product.d.ts:300 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:263 +medusa/dist/api/routes/admin/products/create-product.d.ts:302 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:266 +medusa/dist/api/routes/admin/products/create-product.d.ts:305 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:276 +medusa/dist/api/routes/admin/products/create-product.d.ts:315 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:278 +medusa/dist/api/routes/admin/products/create-product.d.ts:317 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:264 +medusa/dist/api/routes/admin/products/create-product.d.ts:303 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:262 +medusa/dist/api/routes/admin/products/create-product.d.ts:301 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:275 +medusa/dist/api/routes/admin/products/create-product.d.ts:314 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:281 +medusa/dist/api/routes/admin/products/create-product.d.ts:320 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:282 +medusa/dist/api/routes/admin/products/create-product.d.ts:321 ___ @@ -120,17 +120,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:280 +medusa/dist/api/routes/admin/products/create-product.d.ts:319 ___ ### options -• `Optional` **options**: [`ProductOptionReq`](internal-16.ProductOptionReq.md)[] +• `Optional` **options**: [`ProductOptionReq`](internal-18.ProductOptionReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:272 +medusa/dist/api/routes/admin/products/create-product.d.ts:311 ___ @@ -140,17 +140,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:279 +medusa/dist/api/routes/admin/products/create-product.d.ts:318 ___ ### sales\_channels -• `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-16.ProductSalesChannelReq.md)[] +• `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-18.ProductSalesChannelReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:271 +medusa/dist/api/routes/admin/products/create-product.d.ts:310 ___ @@ -160,7 +160,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:267 +medusa/dist/api/routes/admin/products/create-product.d.ts:306 ___ @@ -170,17 +170,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:260 +medusa/dist/api/routes/admin/products/create-product.d.ts:299 ___ ### tags -• `Optional` **tags**: [`ProductTagReq`](internal-16.ProductTagReq.md)[] +• `Optional` **tags**: [`ProductTagReq`](internal-18.ProductTagReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:270 +medusa/dist/api/routes/admin/products/create-product.d.ts:309 ___ @@ -190,7 +190,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:265 +medusa/dist/api/routes/admin/products/create-product.d.ts:304 ___ @@ -200,27 +200,27 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:259 +medusa/dist/api/routes/admin/products/create-product.d.ts:298 ___ ### type -• `Optional` **type**: [`ProductTypeReq`](internal-16.ProductTypeReq.md) +• `Optional` **type**: [`ProductTypeReq`](internal-18.ProductTypeReq.md) #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:268 +medusa/dist/api/routes/admin/products/create-product.d.ts:307 ___ ### variants -• `Optional` **variants**: [`ProductVariantReq`](internal-16.ProductVariantReq.md)[] +• `Optional` **variants**: [`ProductVariantReq`](internal-18.ProductVariantReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:273 +medusa/dist/api/routes/admin/products/create-product.d.ts:312 ___ @@ -230,7 +230,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:274 +medusa/dist/api/routes/admin/products/create-product.d.ts:313 ___ @@ -240,4 +240,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:277 +medusa/dist/api/routes/admin/products/create-product.d.ts:316 diff --git a/docs/content/references/js-client/classes/internal-16.FilterableProductProps.md b/docs/content/references/js-client/classes/internal-18.FilterableProductProps.md similarity index 94% rename from docs/content/references/js-client/classes/internal-16.FilterableProductProps.md rename to docs/content/references/js-client/classes/internal-18.FilterableProductProps.md index 86520f7aa1..61bbc60f87 100644 --- a/docs/content/references/js-client/classes/internal-16.FilterableProductProps.md +++ b/docs/content/references/js-client/classes/internal-18.FilterableProductProps.md @@ -1,6 +1,6 @@ # Class: FilterableProductProps -[internal](../modules/internal-16.md).FilterableProductProps +[internal](../modules/internal-18.md).FilterableProductProps API Level DTOs + Validation rules @@ -8,7 +8,7 @@ API Level DTOs + Validation rules - **`FilterableProductProps`** - ↳ [`AdminGetProductsParams`](internal-16.AdminGetProductsParams.md) + ↳ [`AdminGetProductsParams`](internal-18.AdminGetProductsParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductOptionReq.md b/docs/content/references/js-client/classes/internal-18.ProductOptionReq.md new file mode 100644 index 0000000000..342c49c608 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-18.ProductOptionReq.md @@ -0,0 +1,13 @@ +# Class: ProductOptionReq + +[internal](../modules/internal-18.md).ProductOptionReq + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:274 diff --git a/docs/content/references/js-client/classes/internal-16.ProductSalesChannelReq.md b/docs/content/references/js-client/classes/internal-18.ProductSalesChannelReq.md similarity index 68% rename from docs/content/references/js-client/classes/internal-16.ProductSalesChannelReq.md rename to docs/content/references/js-client/classes/internal-18.ProductSalesChannelReq.md index bd352ad42a..f1fa09c67a 100644 --- a/docs/content/references/js-client/classes/internal-16.ProductSalesChannelReq.md +++ b/docs/content/references/js-client/classes/internal-18.ProductSalesChannelReq.md @@ -1,6 +1,6 @@ # Class: ProductSalesChannelReq -[internal](../modules/internal-16.md).ProductSalesChannelReq +[internal](../modules/internal-18.md).ProductSalesChannelReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-16.ProductTagReq.md b/docs/content/references/js-client/classes/internal-18.ProductTagReq.md similarity index 81% rename from docs/content/references/js-client/classes/internal-16.ProductTagReq.md rename to docs/content/references/js-client/classes/internal-18.ProductTagReq.md index 0df04ee57d..54e731de4b 100644 --- a/docs/content/references/js-client/classes/internal-16.ProductTagReq.md +++ b/docs/content/references/js-client/classes/internal-18.ProductTagReq.md @@ -1,6 +1,6 @@ # Class: ProductTagReq -[internal](../modules/internal-16.md).ProductTagReq +[internal](../modules/internal-18.md).ProductTagReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-16.ProductTypeReq.md b/docs/content/references/js-client/classes/internal-18.ProductTypeReq.md similarity index 81% rename from docs/content/references/js-client/classes/internal-16.ProductTypeReq.md rename to docs/content/references/js-client/classes/internal-18.ProductTypeReq.md index 11478f7b4c..d97b3cd433 100644 --- a/docs/content/references/js-client/classes/internal-16.ProductTypeReq.md +++ b/docs/content/references/js-client/classes/internal-18.ProductTypeReq.md @@ -1,6 +1,6 @@ # Class: ProductTypeReq -[internal](../modules/internal-16.md).ProductTypeReq +[internal](../modules/internal-18.md).ProductTypeReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-1.md b/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-1.md new file mode 100644 index 0000000000..52fbba014d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-1.md @@ -0,0 +1,23 @@ +# Class: ProductVariantOptionReq + +[internal](../modules/internal-18.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:181 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:180 diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-2.md b/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-2.md new file mode 100644 index 0000000000..e24761d83e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-2.md @@ -0,0 +1,13 @@ +# Class: ProductVariantOptionReq + +[internal](../modules/internal-18.md).ProductVariantOptionReq + +## Properties + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:271 diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-3.md b/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-3.md new file mode 100644 index 0000000000..cd2f3f15b7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-3.md @@ -0,0 +1,23 @@ +# Class: ProductVariantOptionReq + +[internal](../modules/internal-18.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:259 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:258 diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq.md b/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq.md new file mode 100644 index 0000000000..222ddbcecb --- /dev/null +++ b/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq.md @@ -0,0 +1,23 @@ +# Class: ProductVariantOptionReq + +[internal](../modules/internal-18.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:189 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:188 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantPricesCreateReq.md b/docs/content/references/js-client/classes/internal-18.ProductVariantPricesCreateReq.md similarity index 91% rename from docs/content/references/js-client/classes/internal-16.ProductVariantPricesCreateReq.md rename to docs/content/references/js-client/classes/internal-18.ProductVariantPricesCreateReq.md index b4a53e62ab..3fcdca0784 100644 --- a/docs/content/references/js-client/classes/internal-16.ProductVariantPricesCreateReq.md +++ b/docs/content/references/js-client/classes/internal-18.ProductVariantPricesCreateReq.md @@ -1,6 +1,6 @@ # Class: ProductVariantPricesCreateReq -[internal](../modules/internal-16.md).ProductVariantPricesCreateReq +[internal](../modules/internal-18.md).ProductVariantPricesCreateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantPricesUpdateReq.md b/docs/content/references/js-client/classes/internal-18.ProductVariantPricesUpdateReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-16.ProductVariantPricesUpdateReq.md rename to docs/content/references/js-client/classes/internal-18.ProductVariantPricesUpdateReq.md index 020637c1e1..a31ff329a9 100644 --- a/docs/content/references/js-client/classes/internal-16.ProductVariantPricesUpdateReq.md +++ b/docs/content/references/js-client/classes/internal-18.ProductVariantPricesUpdateReq.md @@ -1,6 +1,6 @@ # Class: ProductVariantPricesUpdateReq -[internal](../modules/internal-16.md).ProductVariantPricesUpdateReq +[internal](../modules/internal-18.md).ProductVariantPricesUpdateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantReq-1.md b/docs/content/references/js-client/classes/internal-18.ProductVariantReq-1.md similarity index 53% rename from docs/content/references/js-client/classes/internal-16.ProductVariantReq-1.md rename to docs/content/references/js-client/classes/internal-18.ProductVariantReq-1.md index 281334f577..db681df7d4 100644 --- a/docs/content/references/js-client/classes/internal-16.ProductVariantReq-1.md +++ b/docs/content/references/js-client/classes/internal-18.ProductVariantReq-1.md @@ -1,6 +1,6 @@ # Class: ProductVariantReq -[internal](../modules/internal-16.md).ProductVariantReq +[internal](../modules/internal-18.md).ProductVariantReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:232 +medusa/dist/api/routes/admin/products/update-product.d.ts:270 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:229 +medusa/dist/api/routes/admin/products/update-product.d.ts:267 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:227 +medusa/dist/api/routes/admin/products/update-product.d.ts:265 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:236 +medusa/dist/api/routes/admin/products/update-product.d.ts:274 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:230 +medusa/dist/api/routes/admin/products/update-product.d.ts:268 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:224 +medusa/dist/api/routes/admin/products/update-product.d.ts:262 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:231 +medusa/dist/api/routes/admin/products/update-product.d.ts:269 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:235 +medusa/dist/api/routes/admin/products/update-product.d.ts:273 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:233 +medusa/dist/api/routes/admin/products/update-product.d.ts:271 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:240 +medusa/dist/api/routes/admin/products/update-product.d.ts:278 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:241 +medusa/dist/api/routes/admin/products/update-product.d.ts:279 ___ @@ -120,17 +120,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:239 +medusa/dist/api/routes/admin/products/update-product.d.ts:277 ___ ### options -• `Optional` **options**: [`ProductVariantOptionReq`](internal-16.ProductVariantOptionReq-3.md)[] +• `Optional` **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-3.md)[] #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:243 +medusa/dist/api/routes/admin/products/update-product.d.ts:281 ___ @@ -140,17 +140,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:238 +medusa/dist/api/routes/admin/products/update-product.d.ts:276 ___ ### prices -• **prices**: [`ProductVariantPricesUpdateReq`](internal-16.ProductVariantPricesUpdateReq.md)[] +• **prices**: [`ProductVariantPricesUpdateReq`](internal-18.ProductVariantPricesUpdateReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:242 +medusa/dist/api/routes/admin/products/update-product.d.ts:280 ___ @@ -160,7 +160,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:226 +medusa/dist/api/routes/admin/products/update-product.d.ts:264 ___ @@ -170,7 +170,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:225 +medusa/dist/api/routes/admin/products/update-product.d.ts:263 ___ @@ -180,7 +180,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:228 +medusa/dist/api/routes/admin/products/update-product.d.ts:266 ___ @@ -190,7 +190,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:234 +medusa/dist/api/routes/admin/products/update-product.d.ts:272 ___ @@ -200,4 +200,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/update-product.d.ts:237 +medusa/dist/api/routes/admin/products/update-product.d.ts:275 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantReq.md b/docs/content/references/js-client/classes/internal-18.ProductVariantReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-16.ProductVariantReq.md rename to docs/content/references/js-client/classes/internal-18.ProductVariantReq.md index e676f23fdf..db2d3ebdb6 100644 --- a/docs/content/references/js-client/classes/internal-16.ProductVariantReq.md +++ b/docs/content/references/js-client/classes/internal-18.ProductVariantReq.md @@ -1,6 +1,6 @@ # Class: ProductVariantReq -[internal](../modules/internal-16.md).ProductVariantReq +[internal](../modules/internal-18.md).ProductVariantReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:245 +medusa/dist/api/routes/admin/products/create-product.d.ts:284 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:242 +medusa/dist/api/routes/admin/products/create-product.d.ts:281 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:240 +medusa/dist/api/routes/admin/products/create-product.d.ts:279 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:249 +medusa/dist/api/routes/admin/products/create-product.d.ts:288 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:243 +medusa/dist/api/routes/admin/products/create-product.d.ts:282 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:244 +medusa/dist/api/routes/admin/products/create-product.d.ts:283 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:248 +medusa/dist/api/routes/admin/products/create-product.d.ts:287 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:246 +medusa/dist/api/routes/admin/products/create-product.d.ts:285 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:253 +medusa/dist/api/routes/admin/products/create-product.d.ts:292 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:254 +medusa/dist/api/routes/admin/products/create-product.d.ts:293 ___ @@ -110,17 +110,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:252 +medusa/dist/api/routes/admin/products/create-product.d.ts:291 ___ ### options -• `Optional` **options**: [`ProductVariantOptionReq`](internal-16.ProductVariantOptionReq-2.md)[] +• `Optional` **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-2.md)[] #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:256 +medusa/dist/api/routes/admin/products/create-product.d.ts:295 ___ @@ -130,17 +130,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:251 +medusa/dist/api/routes/admin/products/create-product.d.ts:290 ___ ### prices -• **prices**: [`ProductVariantPricesCreateReq`](internal-16.ProductVariantPricesCreateReq.md)[] +• **prices**: [`ProductVariantPricesCreateReq`](internal-18.ProductVariantPricesCreateReq.md)[] #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:255 +medusa/dist/api/routes/admin/products/create-product.d.ts:294 ___ @@ -150,7 +150,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:239 +medusa/dist/api/routes/admin/products/create-product.d.ts:278 ___ @@ -160,7 +160,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:238 +medusa/dist/api/routes/admin/products/create-product.d.ts:277 ___ @@ -170,7 +170,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:241 +medusa/dist/api/routes/admin/products/create-product.d.ts:280 ___ @@ -180,7 +180,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:247 +medusa/dist/api/routes/admin/products/create-product.d.ts:286 ___ @@ -190,4 +190,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/products/create-product.d.ts:250 +medusa/dist/api/routes/admin/products/create-product.d.ts:289 diff --git a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsPaginationParams.md b/docs/content/references/js-client/classes/internal-19.AdminGetRegionsPaginationParams.md similarity index 51% rename from docs/content/references/js-client/classes/internal-17.AdminGetRegionsPaginationParams.md rename to docs/content/references/js-client/classes/internal-19.AdminGetRegionsPaginationParams.md index b260d5bba6..ba505427c7 100644 --- a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-19.AdminGetRegionsPaginationParams.md @@ -1,12 +1,12 @@ # Class: AdminGetRegionsPaginationParams -[internal](../modules/internal-17.md).AdminGetRegionsPaginationParams +[internal](../modules/internal-19.md).AdminGetRegionsPaginationParams ## Hierarchy - **`AdminGetRegionsPaginationParams`** - ↳ [`AdminGetRegionsParams`](internal-17.AdminGetRegionsParams.md) + ↳ [`AdminGetRegionsParams`](internal-19.AdminGetRegionsParams.md) ## Properties @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/regions/list-regions.d.ts:67 +medusa/dist/api/routes/admin/regions/list-regions.d.ts:98 ___ @@ -26,4 +26,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/list-regions.d.ts:68 +medusa/dist/api/routes/admin/regions/list-regions.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsParams.md b/docs/content/references/js-client/classes/internal-19.AdminGetRegionsParams.md similarity index 52% rename from docs/content/references/js-client/classes/internal-17.AdminGetRegionsParams.md rename to docs/content/references/js-client/classes/internal-19.AdminGetRegionsParams.md index 053dd32706..bd2775dfcc 100644 --- a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsParams.md +++ b/docs/content/references/js-client/classes/internal-19.AdminGetRegionsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetRegionsParams -[internal](../modules/internal-17.md).AdminGetRegionsParams +[internal](../modules/internal-19.md).AdminGetRegionsParams ## Hierarchy -- [`AdminGetRegionsPaginationParams`](internal-17.AdminGetRegionsPaginationParams.md) +- [`AdminGetRegionsPaginationParams`](internal-19.AdminGetRegionsPaginationParams.md) ↳ **`AdminGetRegionsParams`** @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/regions/list-regions.d.ts:71 +medusa/dist/api/routes/admin/regions/list-regions.d.ts:102 ___ @@ -26,7 +26,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/list-regions.d.ts:73 +medusa/dist/api/routes/admin/regions/list-regions.d.ts:104 ___ @@ -36,11 +36,11 @@ ___ #### Inherited from -[AdminGetRegionsPaginationParams](internal-17.AdminGetRegionsPaginationParams.md).[limit](internal-17.AdminGetRegionsPaginationParams.md#limit) +[AdminGetRegionsPaginationParams](internal-19.AdminGetRegionsPaginationParams.md).[limit](internal-19.AdminGetRegionsPaginationParams.md#limit) #### Defined in -medusa/dist/api/routes/admin/regions/list-regions.d.ts:67 +medusa/dist/api/routes/admin/regions/list-regions.d.ts:98 ___ @@ -50,11 +50,11 @@ ___ #### Inherited from -[AdminGetRegionsPaginationParams](internal-17.AdminGetRegionsPaginationParams.md).[offset](internal-17.AdminGetRegionsPaginationParams.md#offset) +[AdminGetRegionsPaginationParams](internal-19.AdminGetRegionsPaginationParams.md).[offset](internal-19.AdminGetRegionsPaginationParams.md#offset) #### Defined in -medusa/dist/api/routes/admin/regions/list-regions.d.ts:68 +medusa/dist/api/routes/admin/regions/list-regions.d.ts:99 ___ @@ -64,4 +64,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/list-regions.d.ts:72 +medusa/dist/api/routes/admin/regions/list-regions.d.ts:103 diff --git a/docs/content/references/js-client/classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md b/docs/content/references/js-client/classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md new file mode 100644 index 0000000000..988f6d0487 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md @@ -0,0 +1,13 @@ +# Class: AdminGetRegionsRegionFulfillmentOptionsRes + +[internal](../modules/internal-19.md).AdminGetRegionsRegionFulfillmentOptionsRes + +## Properties + +### fulfillment\_options + +• **fulfillment\_options**: [`FulfillmentOption`](internal-19.FulfillmentOption.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/index.d.ts:21 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionCountriesReq.md b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionCountriesReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionCountriesReq.md rename to docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionCountriesReq.md index 1434edcfd3..4775f1901c 100644 --- a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionCountriesReq.md +++ b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionCountriesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsRegionCountriesReq -[internal](../modules/internal-17.md).AdminPostRegionsRegionCountriesReq +[internal](../modules/internal-19.md).AdminPostRegionsRegionCountriesReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/regions/add-country.d.ts:37 +medusa/dist/api/routes/admin/regions/add-country.d.ts:74 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md rename to docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md index 3738199854..46ab825913 100644 --- a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md +++ b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsRegionFulfillmentProvidersReq -[internal](../modules/internal-17.md).AdminPostRegionsRegionFulfillmentProvidersReq +[internal](../modules/internal-19.md).AdminPostRegionsRegionFulfillmentProvidersReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts:34 +medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts:71 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md rename to docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md index 4ce97948ed..e193256e63 100644 --- a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md +++ b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsRegionPaymentProvidersReq -[internal](../modules/internal-17.md).AdminPostRegionsRegionPaymentProvidersReq +[internal](../modules/internal-19.md).AdminPostRegionsRegionPaymentProvidersReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts:34 +medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts:71 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionReq.md b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionReq.md rename to docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionReq.md index afb078a6b5..749cf66d20 100644 --- a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionReq.md +++ b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsRegionReq -[internal](../modules/internal-17.md).AdminPostRegionsRegionReq +[internal](../modules/internal-19.md).AdminPostRegionsRegionReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:73 +medusa/dist/api/routes/admin/regions/update-region.d.ts:113 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:77 +medusa/dist/api/routes/admin/regions/update-region.d.ts:117 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:69 +medusa/dist/api/routes/admin/regions/update-region.d.ts:109 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:76 +medusa/dist/api/routes/admin/regions/update-region.d.ts:116 ___ @@ -50,7 +50,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:72 +medusa/dist/api/routes/admin/regions/update-region.d.ts:112 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/regions/update-region.d.ts:118 ___ @@ -60,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:78 +medusa/dist/api/routes/admin/regions/update-region.d.ts:119 ___ @@ -70,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:68 +medusa/dist/api/routes/admin/regions/update-region.d.ts:108 ___ @@ -80,7 +90,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:75 +medusa/dist/api/routes/admin/regions/update-region.d.ts:115 ___ @@ -90,7 +100,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:70 +medusa/dist/api/routes/admin/regions/update-region.d.ts:110 ___ @@ -100,7 +110,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:74 +medusa/dist/api/routes/admin/regions/update-region.d.ts:114 ___ @@ -110,4 +120,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/update-region.d.ts:71 +medusa/dist/api/routes/admin/regions/update-region.d.ts:111 diff --git a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsReq.md b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsReq.md new file mode 100644 index 0000000000..fa4b6da7b2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-19.AdminPostRegionsReq.md @@ -0,0 +1,93 @@ +# Class: AdminPostRegionsReq + +[internal](../modules/internal-19.md).AdminPostRegionsReq + +## Properties + +### countries + +• **countries**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:133 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:128 + +___ + +### fulfillment\_providers + +• **fulfillment\_providers**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:132 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:134 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:135 + +___ + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:127 + +___ + +### payment\_providers + +• **payment\_providers**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:131 + +___ + +### tax\_code + +• `Optional` **tax\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:129 + +___ + +### tax\_rate + +• **tax\_rate**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:130 diff --git a/docs/content/references/js-client/classes/internal-19.AdminPostReturnsReturnReceiveReq.md b/docs/content/references/js-client/classes/internal-19.AdminPostReturnsReturnReceiveReq.md deleted file mode 100644 index 94302c9fd3..0000000000 --- a/docs/content/references/js-client/classes/internal-19.AdminPostReturnsReturnReceiveReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostReturnsReturnReceiveReq - -[internal](../modules/internal-19.md).AdminPostReturnsReturnReceiveReq - -## Properties - -### items - -• **items**: [`Item`](internal-19.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/returns/receive-return.d.ts:51 - -___ - -### refund - -• `Optional` **refund**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/returns/receive-return.d.ts:52 diff --git a/docs/content/references/js-client/classes/internal-17.AdminRegionsRes.md b/docs/content/references/js-client/classes/internal-19.AdminRegionsRes.md similarity index 53% rename from docs/content/references/js-client/classes/internal-17.AdminRegionsRes.md rename to docs/content/references/js-client/classes/internal-19.AdminRegionsRes.md index 22b62f2d71..dafe699bd4 100644 --- a/docs/content/references/js-client/classes/internal-17.AdminRegionsRes.md +++ b/docs/content/references/js-client/classes/internal-19.AdminRegionsRes.md @@ -1,6 +1,6 @@ # Class: AdminRegionsRes -[internal](../modules/internal-17.md).AdminRegionsRes +[internal](../modules/internal-19.md).AdminRegionsRes ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/regions/index.d.ts:9 +medusa/dist/api/routes/admin/regions/index.d.ts:10 diff --git a/docs/content/references/js-client/classes/internal-17.FulfillmentOption.md b/docs/content/references/js-client/classes/internal-19.FulfillmentOption.md similarity index 68% rename from docs/content/references/js-client/classes/internal-17.FulfillmentOption.md rename to docs/content/references/js-client/classes/internal-19.FulfillmentOption.md index 6b8049e15b..b96388c8e4 100644 --- a/docs/content/references/js-client/classes/internal-17.FulfillmentOption.md +++ b/docs/content/references/js-client/classes/internal-19.FulfillmentOption.md @@ -1,6 +1,6 @@ # Class: FulfillmentOption -[internal](../modules/internal-17.md).FulfillmentOption +[internal](../modules/internal-19.md).FulfillmentOption ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/regions/index.d.ts:17 +medusa/dist/api/routes/admin/regions/index.d.ts:18 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/regions/index.d.ts:16 +medusa/dist/api/routes/admin/regions/index.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal-19.Item.md b/docs/content/references/js-client/classes/internal-19.Item.md deleted file mode 100644 index 2dad01ec41..0000000000 --- a/docs/content/references/js-client/classes/internal-19.Item.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: Item - -[internal](../modules/internal-19.md).Item - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/returns/receive-return.d.ts:47 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/returns/receive-return.d.ts:48 diff --git a/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md b/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md index d377c80adb..53ae088fcd 100644 --- a/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:233 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:264 ___ @@ -26,7 +26,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:234 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:265 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:231 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:262 ___ @@ -46,7 +46,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:232 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:263 ___ @@ -56,4 +56,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:235 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:266 diff --git a/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md b/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md index f3e69b9d03..f250548294 100644 --- a/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md +++ b/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:244 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:275 ___ @@ -26,7 +26,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:242 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:273 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:240 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:271 ___ @@ -46,7 +46,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:245 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:276 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:233 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:264 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:243 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:274 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:234 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:265 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:238 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:269 ___ @@ -108,7 +108,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:231 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:262 ___ @@ -122,7 +122,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:232 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:263 ___ @@ -136,7 +136,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:235 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:266 ___ @@ -146,7 +146,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:241 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:272 ___ @@ -156,7 +156,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:239 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:270 ___ @@ -166,4 +166,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:246 +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:277 diff --git a/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md b/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md index 2772270709..980404ad14 100644 --- a/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md +++ b/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:59 +medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:98 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:60 +medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:99 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:58 +medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:97 diff --git a/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md b/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md index c22d487386..4f665a093e 100644 --- a/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md +++ b/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/types/common.d.ts:73 +medusa/dist/types/common.d.ts:74 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:74 +medusa/dist/types/common.d.ts:75 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:72 +medusa/dist/types/common.d.ts:73 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:75 +medusa/dist/types/common.d.ts:76 diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReasonReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReasonReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReasonReq.md rename to docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReasonReq.md index a2026db21e..9aa35e6e3a 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReasonReq.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReasonReq.md @@ -1,6 +1,6 @@ # Class: AdminPostReturnReasonsReasonReq -[internal](../modules/internal-18.md).AdminPostReturnReasonsReasonReq +[internal](../modules/internal-20.md).AdminPostReturnReasonsReasonReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:43 +medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:80 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:41 +medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:78 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:44 +medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:81 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:42 +medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:79 diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReq.md rename to docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReq.md index 76e1125f8d..34ba6fa6b7 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReq.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostReturnReasonsReq -[internal](../modules/internal-18.md).AdminPostReturnReasonsReq +[internal](../modules/internal-20.md).AdminPostReturnReasonsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:48 +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:87 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:46 +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:85 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:49 +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:88 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:47 +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:86 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:45 +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:84 diff --git a/docs/content/references/js-client/classes/internal-19.AdminGetReturnsParams.md b/docs/content/references/js-client/classes/internal-21.AdminGetReturnsParams.md similarity index 51% rename from docs/content/references/js-client/classes/internal-19.AdminGetReturnsParams.md rename to docs/content/references/js-client/classes/internal-21.AdminGetReturnsParams.md index 5366ba334f..b63d08a23b 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminGetReturnsParams.md +++ b/docs/content/references/js-client/classes/internal-21.AdminGetReturnsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetReturnsParams -[internal](../modules/internal-19.md).AdminGetReturnsParams +[internal](../modules/internal-21.md).AdminGetReturnsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/returns/list-returns.d.ts:35 +medusa/dist/api/routes/admin/returns/list-returns.d.ts:66 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/returns/list-returns.d.ts:36 +medusa/dist/api/routes/admin/returns/list-returns.d.ts:67 diff --git a/docs/content/references/js-client/classes/internal-21.AdminPostReturnsReturnReceiveReq.md b/docs/content/references/js-client/classes/internal-21.AdminPostReturnsReturnReceiveReq.md new file mode 100644 index 0000000000..6dbac98fa3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.AdminPostReturnsReturnReceiveReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostReturnsReturnReceiveReq + +[internal](../modules/internal-21.md).AdminPostReturnsReturnReceiveReq + +## Properties + +### items + +• **items**: [`Item`](internal-21.Item.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/returns/receive-return.d.ts:98 + +___ + +### refund + +• `Optional` **refund**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/returns/receive-return.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal-21.Item.md b/docs/content/references/js-client/classes/internal-21.Item.md new file mode 100644 index 0000000000..f9d349f418 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.Item.md @@ -0,0 +1,23 @@ +# Class: Item + +[internal](../modules/internal-21.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/returns/receive-return.d.ts:94 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/returns/receive-return.d.ts:95 diff --git a/docs/content/references/js-client/classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md b/docs/content/references/js-client/classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md similarity index 62% rename from docs/content/references/js-client/classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md rename to docs/content/references/js-client/classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md index ed3430cfbd..ebb8ebaa68 100644 --- a/docs/content/references/js-client/classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md @@ -1,13 +1,13 @@ # Class: AdminDeleteSalesChannelsChannelProductsBatchReq -[internal](../modules/internal-20.md).AdminDeleteSalesChannelsChannelProductsBatchReq +[internal](../modules/internal-22.md).AdminDeleteSalesChannelsChannelProductsBatchReq ## Properties ### product\_ids -• **product\_ids**: [`ProductBatchSalesChannel`](internal-20.ProductBatchSalesChannel.md)[] +• **product\_ids**: [`ProductBatchSalesChannel`](internal-22.ProductBatchSalesChannel.md)[] #### Defined in -medusa/dist/api/routes/admin/sales-channels/delete-products-batch.d.ts:44 +medusa/dist/api/routes/admin/sales-channels/delete-products-batch.d.ts:89 diff --git a/docs/content/references/js-client/classes/internal-20.AdminGetSalesChannelsParams.md b/docs/content/references/js-client/classes/internal-22.AdminGetSalesChannelsParams.md similarity index 88% rename from docs/content/references/js-client/classes/internal-20.AdminGetSalesChannelsParams.md rename to docs/content/references/js-client/classes/internal-22.AdminGetSalesChannelsParams.md index 059999e868..e05b0dd0e5 100644 --- a/docs/content/references/js-client/classes/internal-20.AdminGetSalesChannelsParams.md +++ b/docs/content/references/js-client/classes/internal-22.AdminGetSalesChannelsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetSalesChannelsParams -[internal](../modules/internal-20.md).AdminGetSalesChannelsParams +[internal](../modules/internal-22.md).AdminGetSalesChannelsParams ## Hierarchy -- [`AdminGetSalesChannelsParams_base`](../modules/internal-20.md#admingetsaleschannelsparams_base) +- [`AdminGetSalesChannelsParams_base`](../modules/internal-22.md#admingetsaleschannelsparams_base) ↳ **`AdminGetSalesChannelsParams`** @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:116 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:147 ___ @@ -26,7 +26,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:118 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:149 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:115 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:146 ___ @@ -50,7 +50,7 @@ AdminGetSalesChannelsParams\_base.expand #### Defined in -medusa/dist/types/common.d.ts:116 +medusa/dist/types/common.d.ts:117 ___ @@ -64,7 +64,7 @@ AdminGetSalesChannelsParams\_base.fields #### Defined in -medusa/dist/types/common.d.ts:117 +medusa/dist/types/common.d.ts:118 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:112 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:143 ___ @@ -88,7 +88,7 @@ AdminGetSalesChannelsParams\_base.limit #### Defined in -medusa/dist/types/common.d.ts:121 +medusa/dist/types/common.d.ts:122 ___ @@ -98,7 +98,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:114 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:145 ___ @@ -112,7 +112,7 @@ AdminGetSalesChannelsParams\_base.offset #### Defined in -medusa/dist/types/common.d.ts:120 +medusa/dist/types/common.d.ts:121 ___ @@ -122,7 +122,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:119 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:150 ___ @@ -132,7 +132,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:113 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:144 ___ @@ -142,4 +142,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:117 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:148 diff --git a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md similarity index 62% rename from docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md rename to docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md index 4689efc0bf..ea5b24579e 100644 --- a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md @@ -1,13 +1,13 @@ # Class: AdminPostSalesChannelsChannelProductsBatchReq -[internal](../modules/internal-20.md).AdminPostSalesChannelsChannelProductsBatchReq +[internal](../modules/internal-22.md).AdminPostSalesChannelsChannelProductsBatchReq ## Properties ### product\_ids -• **product\_ids**: [`ProductBatchSalesChannel`](internal-20.ProductBatchSalesChannel.md)[] +• **product\_ids**: [`ProductBatchSalesChannel`](internal-22.ProductBatchSalesChannel.md)[] #### Defined in -medusa/dist/api/routes/admin/sales-channels/add-product-batch.d.ts:44 +medusa/dist/api/routes/admin/sales-channels/add-product-batch.d.ts:89 diff --git a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsReq.md similarity index 83% rename from docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsReq.md rename to docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsReq.md index 97956ffdd6..9cc185bce9 100644 --- a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostSalesChannelsReq -[internal](../modules/internal-20.md).AdminPostSalesChannelsReq +[internal](../modules/internal-22.md).AdminPostSalesChannelsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:40 +medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:78 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:41 +medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:79 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:39 +medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:77 diff --git a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md similarity index 84% rename from docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md rename to docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md index 60f2859c4f..224aab73b1 100644 --- a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md @@ -1,6 +1,6 @@ # Class: AdminPostSalesChannelsSalesChannelReq -[internal](../modules/internal-20.md).AdminPostSalesChannelsSalesChannelReq +[internal](../modules/internal-22.md).AdminPostSalesChannelsSalesChannelReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:40 +medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:77 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:41 +medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:78 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:39 +medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:76 diff --git a/docs/content/references/js-client/classes/internal-20.ProductBatchSalesChannel.md b/docs/content/references/js-client/classes/internal-22.ProductBatchSalesChannel.md similarity index 68% rename from docs/content/references/js-client/classes/internal-20.ProductBatchSalesChannel.md rename to docs/content/references/js-client/classes/internal-22.ProductBatchSalesChannel.md index 57d96c830c..efe2ab72e2 100644 --- a/docs/content/references/js-client/classes/internal-20.ProductBatchSalesChannel.md +++ b/docs/content/references/js-client/classes/internal-22.ProductBatchSalesChannel.md @@ -1,6 +1,6 @@ # Class: ProductBatchSalesChannel -[internal](../modules/internal-20.md).ProductBatchSalesChannel +[internal](../modules/internal-22.md).ProductBatchSalesChannel ## Properties diff --git a/docs/content/references/js-client/classes/internal-21.AdminGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-23.AdminGetShippingOptionsParams.md similarity index 83% rename from docs/content/references/js-client/classes/internal-21.AdminGetShippingOptionsParams.md rename to docs/content/references/js-client/classes/internal-23.AdminGetShippingOptionsParams.md index cfb73e7a97..9a5287e13a 100644 --- a/docs/content/references/js-client/classes/internal-21.AdminGetShippingOptionsParams.md +++ b/docs/content/references/js-client/classes/internal-23.AdminGetShippingOptionsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetShippingOptionsParams -[internal](../modules/internal-21.md).AdminGetShippingOptionsParams +[internal](../modules/internal-23.md).AdminGetShippingOptionsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:45 +medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:76 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:44 +medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:75 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:43 +medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:74 diff --git a/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsOptionReq.md b/docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsOptionReq.md similarity index 62% rename from docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsOptionReq.md rename to docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsOptionReq.md index 311c84ccd9..6da7a125ab 100644 --- a/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsOptionReq.md +++ b/docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsOptionReq.md @@ -1,6 +1,6 @@ # Class: AdminPostShippingOptionsOptionReq -[internal](../modules/internal-21.md).AdminPostShippingOptionsOptionReq +[internal](../modules/internal-23.md).AdminPostShippingOptionsOptionReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:71 +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:123 ___ @@ -20,17 +20,27 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:69 +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:121 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:125 ___ ### metadata -• `Optional` **metadata**: `object` +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:72 +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:124 ___ @@ -40,14 +50,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:68 +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:120 ___ ### requirements -• **requirements**: [`OptionRequirement`](internal-21.OptionRequirement-1.md)[] +• **requirements**: [`OptionRequirement`](internal-23.OptionRequirement-1.md)[] #### Defined in -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:70 +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:122 diff --git a/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsReq.md rename to docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsReq.md index 4982e8aa06..d3dbfcbdb5 100644 --- a/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsReq.md +++ b/docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostShippingOptionsReq -[internal](../modules/internal-21.md).AdminPostShippingOptionsReq +[internal](../modules/internal-23.md).AdminPostShippingOptionsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:97 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:146 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:95 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:144 ___ @@ -30,7 +30,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:93 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:142 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:149 ___ @@ -40,17 +50,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:98 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:147 ___ ### metadata -• `Optional` **metadata**: `object` +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:99 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:148 ___ @@ -60,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:89 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:138 ___ @@ -70,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:94 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:143 ___ @@ -80,7 +90,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:92 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:141 ___ @@ -90,7 +100,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:91 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:140 ___ @@ -100,14 +110,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:90 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:139 ___ ### requirements -• `Optional` **requirements**: [`OptionRequirement`](internal-21.OptionRequirement.md)[] +• `Optional` **requirements**: [`OptionRequirement`](internal-23.OptionRequirement.md)[] #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:96 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:145 diff --git a/docs/content/references/js-client/classes/internal-21.OptionRequirement-1.md b/docs/content/references/js-client/classes/internal-23.OptionRequirement-1.md similarity index 80% rename from docs/content/references/js-client/classes/internal-21.OptionRequirement-1.md rename to docs/content/references/js-client/classes/internal-23.OptionRequirement-1.md index 7dcae669ed..d03d0a526e 100644 --- a/docs/content/references/js-client/classes/internal-21.OptionRequirement-1.md +++ b/docs/content/references/js-client/classes/internal-23.OptionRequirement-1.md @@ -1,6 +1,6 @@ # Class: OptionRequirement -[internal](../modules/internal-21.md).OptionRequirement +[internal](../modules/internal-23.md).OptionRequirement ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:65 +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:117 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:63 +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:115 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:64 +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:116 diff --git a/docs/content/references/js-client/classes/internal-21.OptionRequirement.md b/docs/content/references/js-client/classes/internal-23.OptionRequirement.md similarity index 77% rename from docs/content/references/js-client/classes/internal-21.OptionRequirement.md rename to docs/content/references/js-client/classes/internal-23.OptionRequirement.md index c0bd808e82..ceed145625 100644 --- a/docs/content/references/js-client/classes/internal-21.OptionRequirement.md +++ b/docs/content/references/js-client/classes/internal-23.OptionRequirement.md @@ -1,6 +1,6 @@ # Class: OptionRequirement -[internal](../modules/internal-21.md).OptionRequirement +[internal](../modules/internal-23.md).OptionRequirement ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:86 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:135 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:85 +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:134 diff --git a/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesProfileReq.md b/docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesProfileReq.md similarity index 71% rename from docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesProfileReq.md rename to docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesProfileReq.md index 258960e155..67d9277c7a 100644 --- a/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesProfileReq.md +++ b/docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesProfileReq.md @@ -1,6 +1,6 @@ # Class: AdminPostShippingProfilesProfileReq -[internal](../modules/internal-22.md).AdminPostShippingProfilesProfileReq +[internal](../modules/internal-24.md).AdminPostShippingProfilesProfileReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:31 +medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesReq.md b/docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesReq.md similarity index 68% rename from docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesReq.md rename to docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesReq.md index 0c6ad30a9b..4943d416ba 100644 --- a/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesReq.md +++ b/docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostShippingProfilesReq -[internal](../modules/internal-22.md).AdminPostShippingProfilesReq +[internal](../modules/internal-24.md).AdminPostShippingProfilesReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:32 +medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:69 diff --git a/docs/content/references/js-client/classes/internal-23.AdminPostStoreReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostStoreReq.md similarity index 61% rename from docs/content/references/js-client/classes/internal-23.AdminPostStoreReq.md rename to docs/content/references/js-client/classes/internal-25.AdminPostStoreReq.md index 10ae08b708..e4a7a271c2 100644 --- a/docs/content/references/js-client/classes/internal-23.AdminPostStoreReq.md +++ b/docs/content/references/js-client/classes/internal-25.AdminPostStoreReq.md @@ -1,6 +1,6 @@ # Class: AdminPostStoreReq -[internal](../modules/internal-23.md).AdminPostStoreReq +[internal](../modules/internal-25.md).AdminPostStoreReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/store/update-store.d.ts:58 +medusa/dist/api/routes/admin/store/update-store.d.ts:95 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/store/update-store.d.ts:57 +medusa/dist/api/routes/admin/store/update-store.d.ts:94 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/store/update-store.d.ts:56 +medusa/dist/api/routes/admin/store/update-store.d.ts:93 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/store/update-store.d.ts:59 +medusa/dist/api/routes/admin/store/update-store.d.ts:96 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/store/update-store.d.ts:53 +medusa/dist/api/routes/admin/store/update-store.d.ts:90 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/store/update-store.d.ts:55 +medusa/dist/api/routes/admin/store/update-store.d.ts:92 ___ @@ -70,4 +70,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/store/update-store.d.ts:54 +medusa/dist/api/routes/admin/store/update-store.d.ts:91 diff --git a/docs/content/references/js-client/classes/internal-23.Store.md b/docs/content/references/js-client/classes/internal-25.Store.md similarity index 98% rename from docs/content/references/js-client/classes/internal-23.Store.md rename to docs/content/references/js-client/classes/internal-25.Store.md index e579e2b576..57130dc905 100644 --- a/docs/content/references/js-client/classes/internal-23.Store.md +++ b/docs/content/references/js-client/classes/internal-25.Store.md @@ -1,6 +1,6 @@ # Class: Store -[internal](../modules/internal-23.md).Store +[internal](../modules/internal-25.md).Store Base abstract entity for all entities diff --git a/docs/content/references/js-client/classes/internal-26.AdminDeleteUploadsReq.md b/docs/content/references/js-client/classes/internal-26.AdminDeleteUploadsReq.md deleted file mode 100644 index 9072e5bb05..0000000000 --- a/docs/content/references/js-client/classes/internal-26.AdminDeleteUploadsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeleteUploadsReq - -[internal](../modules/internal-26.md).AdminDeleteUploadsReq - -## Properties - -### file\_key - -• **file\_key**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/uploads/delete-upload.d.ts:41 diff --git a/docs/content/references/js-client/classes/internal-24.AdminGetSwapsParams.md b/docs/content/references/js-client/classes/internal-26.AdminGetSwapsParams.md similarity index 52% rename from docs/content/references/js-client/classes/internal-24.AdminGetSwapsParams.md rename to docs/content/references/js-client/classes/internal-26.AdminGetSwapsParams.md index 368121e876..a58a125aee 100644 --- a/docs/content/references/js-client/classes/internal-24.AdminGetSwapsParams.md +++ b/docs/content/references/js-client/classes/internal-26.AdminGetSwapsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetSwapsParams -[internal](../modules/internal-24.md).AdminGetSwapsParams +[internal](../modules/internal-26.md).AdminGetSwapsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:36 +medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:67 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:37 +medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-26.AdminPostUploadsDownloadUrlReq.md b/docs/content/references/js-client/classes/internal-26.AdminPostUploadsDownloadUrlReq.md deleted file mode 100644 index 7c97a43ae4..0000000000 --- a/docs/content/references/js-client/classes/internal-26.AdminPostUploadsDownloadUrlReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostUploadsDownloadUrlReq - -[internal](../modules/internal-26.md).AdminPostUploadsDownloadUrlReq - -## Properties - -### file\_key - -• **file\_key**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/uploads/get-download-url.d.ts:33 diff --git a/docs/content/references/js-client/classes/internal-26.IAdminPostUploadsFileReq.md b/docs/content/references/js-client/classes/internal-26.IAdminPostUploadsFileReq.md deleted file mode 100644 index e448eda98d..0000000000 --- a/docs/content/references/js-client/classes/internal-26.IAdminPostUploadsFileReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: IAdminPostUploadsFileReq - -[internal](../modules/internal-26.md).IAdminPostUploadsFileReq - -## Properties - -### originalName - -• **originalName**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/uploads/create-upload.d.ts:38 - -___ - -### path - -• **path**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/uploads/create-upload.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md similarity index 81% rename from docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md rename to docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md index b4877e71a8..8a049f9184 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md +++ b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateProductTypesParams -[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateProductTypesParams +[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateProductTypesParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:57 +medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:98 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:58 +medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md similarity index 75% rename from docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md rename to docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md index 0a7207d263..53647b0041 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateProductTypesReq -[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateProductTypesReq +[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateProductTypesReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:54 +medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:95 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md similarity index 83% rename from docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md rename to docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md index 177f46b143..e4eef13a20 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md +++ b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateProductsParams -[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateProductsParams +[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateProductsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:57 +medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:98 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:58 +medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md similarity index 74% rename from docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md rename to docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md index 3f3131440c..c4bad115df 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateProductsReq -[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateProductsReq +[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateProductsReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:54 +medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:95 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md similarity index 80% rename from docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md rename to docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md index afec18daf4..faee9a80b3 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md +++ b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateShippingOptionsParams -[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams +[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:57 +medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:98 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:58 +medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md similarity index 75% rename from docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md rename to docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md index b4be4c16eb..e550db229a 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateShippingOptionsReq -[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq +[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:54 +medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:95 diff --git a/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesParams.md b/docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesParams.md similarity index 51% rename from docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesParams.md rename to docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesParams.md index 189884f70a..0b7ec15273 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesParams.md +++ b/docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesParams.md @@ -1,6 +1,6 @@ # Class: AdminGetTaxRatesParams -[internal](../modules/internal-25.md).AdminGetTaxRatesParams +[internal](../modules/internal-27.md).AdminGetTaxRatesParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:92 +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:123 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:96 +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:127 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:97 +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:128 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:95 +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:126 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:91 +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:122 ___ @@ -60,17 +60,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:94 +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:125 ___ ### rate -• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal-25.NumericalComparisonOperator.md) +• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal-27.NumericalComparisonOperator.md) #### Defined in -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:93 +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:124 ___ @@ -80,4 +80,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:90 +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:121 diff --git a/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesTaxRateParams.md b/docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesTaxRateParams.md similarity index 52% rename from docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesTaxRateParams.md rename to docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesTaxRateParams.md index 83b3070ef4..1884565119 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesTaxRateParams.md +++ b/docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesTaxRateParams.md @@ -1,6 +1,6 @@ # Class: AdminGetTaxRatesTaxRateParams -[internal](../modules/internal-25.md).AdminGetTaxRatesTaxRateParams +[internal](../modules/internal-27.md).AdminGetTaxRatesTaxRateParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:42 +medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:73 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:43 +medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:74 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesReq.md b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesReq.md similarity index 52% rename from docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesReq.md rename to docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesReq.md index 16af02489f..c34d50674c 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesReq -[internal](../modules/internal-25.md).AdminPostTaxRatesReq +[internal](../modules/internal-27.md).AdminPostTaxRatesReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:77 +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:118 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:78 +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:119 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:83 +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:124 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:81 +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:122 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:80 +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:121 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:79 +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:120 ___ @@ -70,4 +70,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:82 +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:123 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md rename to docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md index 950374bcb8..88180339a3 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesTaxRateProductTypesReq -[internal](../modules/internal-25.md).AdminPostTaxRatesTaxRateProductTypesReq +[internal](../modules/internal-27.md).AdminPostTaxRatesTaxRateProductTypesReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:54 +medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:95 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md similarity index 51% rename from docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md rename to docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md index 93982abdb2..61e075a9ab 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesTaxRateProductsReq -[internal](../modules/internal-25.md).AdminPostTaxRatesTaxRateProductsReq +[internal](../modules/internal-27.md).AdminPostTaxRatesTaxRateProductsReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:54 +medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:95 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateReq.md b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateReq.md rename to docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateReq.md index 4c891cf578..c14842feea 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesTaxRateReq -[internal](../modules/internal-25.md).AdminPostTaxRatesTaxRateReq +[internal](../modules/internal-27.md).AdminPostTaxRatesTaxRateReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:74 +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:111 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:75 +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:112 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:80 +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:117 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:78 +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:115 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:77 +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:114 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:76 +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:113 ___ @@ -70,4 +70,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:79 +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:116 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md rename to docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md index 87ded649f9..c4cad16bc8 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesTaxRateShippingOptionsReq -[internal](../modules/internal-25.md).AdminPostTaxRatesTaxRateShippingOptionsReq +[internal](../modules/internal-27.md).AdminPostTaxRatesTaxRateShippingOptionsReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:54 +medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:95 diff --git a/docs/content/references/js-client/classes/internal-27.AdminResetPasswordTokenRequest.md b/docs/content/references/js-client/classes/internal-27.AdminResetPasswordTokenRequest.md deleted file mode 100644 index cd9a9fe091..0000000000 --- a/docs/content/references/js-client/classes/internal-27.AdminResetPasswordTokenRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminResetPasswordTokenRequest - -[internal](../modules/internal-27.md).AdminResetPasswordTokenRequest - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/reset-password-token.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-25.NumericalComparisonOperator.md b/docs/content/references/js-client/classes/internal-27.NumericalComparisonOperator.md similarity index 80% rename from docs/content/references/js-client/classes/internal-25.NumericalComparisonOperator.md rename to docs/content/references/js-client/classes/internal-27.NumericalComparisonOperator.md index 00b0d56ea8..988630f6e5 100644 --- a/docs/content/references/js-client/classes/internal-25.NumericalComparisonOperator.md +++ b/docs/content/references/js-client/classes/internal-27.NumericalComparisonOperator.md @@ -1,6 +1,6 @@ # Class: NumericalComparisonOperator -[internal](../modules/internal-25.md).NumericalComparisonOperator +[internal](../modules/internal-27.md).NumericalComparisonOperator ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/types/common.d.ts:85 +medusa/dist/types/common.d.ts:86 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:86 +medusa/dist/types/common.d.ts:87 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:84 +medusa/dist/types/common.d.ts:85 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:87 +medusa/dist/types/common.d.ts:88 diff --git a/docs/content/references/js-client/classes/internal-28.AdminDeleteUploadsReq.md b/docs/content/references/js-client/classes/internal-28.AdminDeleteUploadsReq.md new file mode 100644 index 0000000000..c862de3ab0 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-28.AdminDeleteUploadsReq.md @@ -0,0 +1,13 @@ +# Class: AdminDeleteUploadsReq + +[internal](../modules/internal-28.md).AdminDeleteUploadsReq + +## Properties + +### file\_key + +• **file\_key**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/uploads/delete-upload.d.ts:78 diff --git a/docs/content/references/js-client/classes/internal-28.AdminPostUploadsDownloadUrlReq.md b/docs/content/references/js-client/classes/internal-28.AdminPostUploadsDownloadUrlReq.md new file mode 100644 index 0000000000..b1076adb17 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-28.AdminPostUploadsDownloadUrlReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostUploadsDownloadUrlReq + +[internal](../modules/internal-28.md).AdminPostUploadsDownloadUrlReq + +## Properties + +### file\_key + +• **file\_key**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/uploads/get-download-url.d.ts:70 diff --git a/docs/content/references/js-client/classes/internal-28.IAdminPostUploadsFileReq.md b/docs/content/references/js-client/classes/internal-28.IAdminPostUploadsFileReq.md new file mode 100644 index 0000000000..997a22cac2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-28.IAdminPostUploadsFileReq.md @@ -0,0 +1,23 @@ +# Class: IAdminPostUploadsFileReq + +[internal](../modules/internal-28.md).IAdminPostUploadsFileReq + +## Properties + +### originalName + +• **originalName**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/uploads/create-upload.d.ts:72 + +___ + +### path + +• **path**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/uploads/create-upload.d.ts:73 diff --git a/docs/content/references/js-client/classes/internal-27.AdminCreateUserRequest.md b/docs/content/references/js-client/classes/internal-29.AdminCreateUserRequest.md similarity index 56% rename from docs/content/references/js-client/classes/internal-27.AdminCreateUserRequest.md rename to docs/content/references/js-client/classes/internal-29.AdminCreateUserRequest.md index 4946591503..76d27f9842 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminCreateUserRequest.md +++ b/docs/content/references/js-client/classes/internal-29.AdminCreateUserRequest.md @@ -1,6 +1,6 @@ # Class: AdminCreateUserRequest -[internal](../modules/internal-27.md).AdminCreateUserRequest +[internal](../modules/internal-29.md).AdminCreateUserRequest ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/users/create-user.d.ts:49 +medusa/dist/api/routes/admin/users/create-user.d.ts:88 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/create-user.d.ts:50 +medusa/dist/api/routes/admin/users/create-user.d.ts:89 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/create-user.d.ts:51 +medusa/dist/api/routes/admin/users/create-user.d.ts:90 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/create-user.d.ts:53 +medusa/dist/api/routes/admin/users/create-user.d.ts:92 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/create-user.d.ts:52 +medusa/dist/api/routes/admin/users/create-user.d.ts:91 diff --git a/docs/content/references/js-client/classes/internal-27.AdminResetPasswordRequest.md b/docs/content/references/js-client/classes/internal-29.AdminResetPasswordRequest.md similarity index 50% rename from docs/content/references/js-client/classes/internal-27.AdminResetPasswordRequest.md rename to docs/content/references/js-client/classes/internal-29.AdminResetPasswordRequest.md index 225f754f4b..4ab9516052 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminResetPasswordRequest.md +++ b/docs/content/references/js-client/classes/internal-29.AdminResetPasswordRequest.md @@ -1,6 +1,6 @@ # Class: AdminResetPasswordRequest -[internal](../modules/internal-27.md).AdminResetPasswordRequest +[internal](../modules/internal-29.md).AdminResetPasswordRequest ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/users/reset-password.d.ts:46 +medusa/dist/api/routes/admin/users/reset-password.d.ts:85 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/reset-password.d.ts:48 +medusa/dist/api/routes/admin/users/reset-password.d.ts:87 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/reset-password.d.ts:47 +medusa/dist/api/routes/admin/users/reset-password.d.ts:86 diff --git a/docs/content/references/js-client/classes/internal-29.AdminResetPasswordTokenRequest.md b/docs/content/references/js-client/classes/internal-29.AdminResetPasswordTokenRequest.md new file mode 100644 index 0000000000..11c6b4b734 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-29.AdminResetPasswordTokenRequest.md @@ -0,0 +1,13 @@ +# Class: AdminResetPasswordTokenRequest + +[internal](../modules/internal-29.md).AdminResetPasswordTokenRequest + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/reset-password-token.d.ts:67 diff --git a/docs/content/references/js-client/classes/internal-27.AdminUpdateUserRequest.md b/docs/content/references/js-client/classes/internal-29.AdminUpdateUserRequest.md similarity index 59% rename from docs/content/references/js-client/classes/internal-27.AdminUpdateUserRequest.md rename to docs/content/references/js-client/classes/internal-29.AdminUpdateUserRequest.md index 7419afbb3c..a3e2b0a75a 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminUpdateUserRequest.md +++ b/docs/content/references/js-client/classes/internal-29.AdminUpdateUserRequest.md @@ -1,6 +1,6 @@ # Class: AdminUpdateUserRequest -[internal](../modules/internal-27.md).AdminUpdateUserRequest +[internal](../modules/internal-29.md).AdminUpdateUserRequest ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/users/update-user.d.ts:50 +medusa/dist/api/routes/admin/users/update-user.d.ts:86 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/update-user.d.ts:47 +medusa/dist/api/routes/admin/users/update-user.d.ts:83 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/update-user.d.ts:48 +medusa/dist/api/routes/admin/users/update-user.d.ts:84 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/update-user.d.ts:51 +medusa/dist/api/routes/admin/users/update-user.d.ts:87 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/users/update-user.d.ts:49 +medusa/dist/api/routes/admin/users/update-user.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal-29.StorePostAuthReq.md b/docs/content/references/js-client/classes/internal-29.StorePostAuthReq.md deleted file mode 100644 index f81d2481bb..0000000000 --- a/docs/content/references/js-client/classes/internal-29.StorePostAuthReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: StorePostAuthReq - -[internal](../modules/internal-29.md).StorePostAuthReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/auth/create-session.d.ts:24 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/store/auth/create-session.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md b/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md index 08e700f866..471d3af660 100644 --- a/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md +++ b/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/collections/remove-products.d.ts:49 +medusa/dist/api/routes/admin/collections/remove-products.d.ts:76 diff --git a/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md b/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md index 8d8963f2eb..3c43a5dd71 100644 --- a/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:107 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:138 ___ @@ -26,4 +26,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:108 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:139 diff --git a/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md b/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md index 9de1e8bdaa..8eef8b710d 100644 --- a/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md +++ b/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:113 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:144 ___ @@ -26,7 +26,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:115 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:146 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:112 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:143 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:107 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:138 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:108 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:139 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:116 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:147 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:111 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:142 ___ @@ -94,4 +94,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:114 +medusa/dist/api/routes/admin/collections/list-collections.d.ts:145 diff --git a/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md b/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md index 2331803c5d..7cb858efd3 100644 --- a/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md +++ b/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/collections/update-collection.d.ts:40 +medusa/dist/api/routes/admin/collections/update-collection.d.ts:77 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/update-collection.d.ts:41 +medusa/dist/api/routes/admin/collections/update-collection.d.ts:78 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/update-collection.d.ts:39 +medusa/dist/api/routes/admin/collections/update-collection.d.ts:76 diff --git a/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md b/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md index 4c1b6f5f23..0c7de4345c 100644 --- a/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md +++ b/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/collections/create-collection.d.ts:40 +medusa/dist/api/routes/admin/collections/create-collection.d.ts:77 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/create-collection.d.ts:41 +medusa/dist/api/routes/admin/collections/create-collection.d.ts:78 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/create-collection.d.ts:39 +medusa/dist/api/routes/admin/collections/create-collection.d.ts:76 diff --git a/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md b/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md index 90a289acd7..99b7f4acdc 100644 --- a/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md +++ b/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/collections/add-products.d.ts:38 +medusa/dist/api/routes/admin/collections/add-products.d.ts:65 diff --git a/docs/content/references/js-client/classes/internal-28.AdminGetVariantsParams.md b/docs/content/references/js-client/classes/internal-30.AdminGetVariantsParams.md similarity index 50% rename from docs/content/references/js-client/classes/internal-28.AdminGetVariantsParams.md rename to docs/content/references/js-client/classes/internal-30.AdminGetVariantsParams.md index fb940f572e..deef731e47 100644 --- a/docs/content/references/js-client/classes/internal-28.AdminGetVariantsParams.md +++ b/docs/content/references/js-client/classes/internal-30.AdminGetVariantsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetVariantsParams -[internal](../modules/internal-28.md).AdminGetVariantsParams +[internal](../modules/internal-30.md).AdminGetVariantsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/variants/list-variants.d.ts:38 +medusa/dist/api/routes/admin/variants/list-variants.d.ts:69 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/variants/list-variants.d.ts:39 +medusa/dist/api/routes/admin/variants/list-variants.d.ts:70 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/variants/list-variants.d.ts:37 +medusa/dist/api/routes/admin/variants/list-variants.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-30.Discount.md b/docs/content/references/js-client/classes/internal-30.Discount.md deleted file mode 100644 index 8d11117c91..0000000000 --- a/docs/content/references/js-client/classes/internal-30.Discount.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: Discount - -[internal](../modules/internal-30.md).Discount - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:91 diff --git a/docs/content/references/js-client/classes/internal-30.GiftCard.md b/docs/content/references/js-client/classes/internal-30.GiftCard.md deleted file mode 100644 index 56ffb525df..0000000000 --- a/docs/content/references/js-client/classes/internal-30.GiftCard.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: GiftCard - -[internal](../modules/internal-30.md).GiftCard - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:88 diff --git a/docs/content/references/js-client/classes/internal-31.StorePostAuthReq.md b/docs/content/references/js-client/classes/internal-31.StorePostAuthReq.md new file mode 100644 index 0000000000..c7aa9a1802 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-31.StorePostAuthReq.md @@ -0,0 +1,23 @@ +# Class: StorePostAuthReq + +[internal](../modules/internal-31.md).StorePostAuthReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/auth/create-session.d.ts:58 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/store/auth/create-session.d.ts:59 diff --git a/docs/content/references/js-client/classes/internal-32.Discount.md b/docs/content/references/js-client/classes/internal-32.Discount.md new file mode 100644 index 0000000000..366299d902 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-32.Discount.md @@ -0,0 +1,13 @@ +# Class: Discount + +[internal](../modules/internal-32.md).Discount + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:121 diff --git a/docs/content/references/js-client/classes/internal-32.GiftCard.md b/docs/content/references/js-client/classes/internal-32.GiftCard.md new file mode 100644 index 0000000000..c1c9619caf --- /dev/null +++ b/docs/content/references/js-client/classes/internal-32.GiftCard.md @@ -0,0 +1,13 @@ +# Class: GiftCard + +[internal](../modules/internal-32.md).GiftCard + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:118 diff --git a/docs/content/references/js-client/classes/internal-30.Item.md b/docs/content/references/js-client/classes/internal-32.Item.md similarity index 51% rename from docs/content/references/js-client/classes/internal-30.Item.md rename to docs/content/references/js-client/classes/internal-32.Item.md index 7470c010ce..6378136f5b 100644 --- a/docs/content/references/js-client/classes/internal-30.Item.md +++ b/docs/content/references/js-client/classes/internal-32.Item.md @@ -1,6 +1,6 @@ # Class: Item -[internal](../modules/internal-30.md).Item +[internal](../modules/internal-32.md).Item ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/carts/create-cart.d.ts:62 +medusa/dist/api/routes/store/carts/create-cart.d.ts:86 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/create-cart.d.ts:61 +medusa/dist/api/routes/store/carts/create-cart.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCartReq.md similarity index 51% rename from docs/content/references/js-client/classes/internal-30.StorePostCartReq.md rename to docs/content/references/js-client/classes/internal-32.StorePostCartReq.md index f69572952d..e5dd7bce13 100644 --- a/docs/content/references/js-client/classes/internal-30.StorePostCartReq.md +++ b/docs/content/references/js-client/classes/internal-32.StorePostCartReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartReq -[internal](../modules/internal-30.md).StorePostCartReq +[internal](../modules/internal-32.md).StorePostCartReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/carts/create-cart.d.ts:68 +medusa/dist/api/routes/store/carts/create-cart.d.ts:92 ___ @@ -20,17 +20,17 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/create-cart.d.ts:66 +medusa/dist/api/routes/store/carts/create-cart.d.ts:90 ___ ### items -• `Optional` **items**: [`Item`](internal-30.Item.md)[] +• `Optional` **items**: [`Item`](internal-32.Item.md)[] #### Defined in -medusa/dist/api/routes/store/carts/create-cart.d.ts:67 +medusa/dist/api/routes/store/carts/create-cart.d.ts:91 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/create-cart.d.ts:65 +medusa/dist/api/routes/store/carts/create-cart.d.ts:89 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/create-cart.d.ts:69 +medusa/dist/api/routes/store/carts/create-cart.d.ts:93 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionReq.md similarity index 52% rename from docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionReq.md rename to docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionReq.md index 5080e0b5d2..92eb2db1c5 100644 --- a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionReq.md +++ b/docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartPaymentSessionReq -[internal](../modules/internal-30.md).StorePostCartsCartPaymentSessionReq +[internal](../modules/internal-32.md).StorePostCartsCartPaymentSessionReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/store/carts/set-payment-session.d.ts:24 +medusa/dist/api/routes/store/carts/set-payment-session.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md rename to docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md index e36de38109..2cd6a3020f 100644 --- a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md +++ b/docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartPaymentSessionUpdateReq -[internal](../modules/internal-30.md).StorePostCartsCartPaymentSessionUpdateReq +[internal](../modules/internal-32.md).StorePostCartsCartPaymentSessionUpdateReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/store/carts/update-payment-session.d.ts:25 +medusa/dist/api/routes/store/carts/update-payment-session.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCartsCartReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal-30.StorePostCartsCartReq.md rename to docs/content/references/js-client/classes/internal-32.StorePostCartsCartReq.md index f00619a924..f78c2863e7 100644 --- a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartReq.md +++ b/docs/content/references/js-client/classes/internal-32.StorePostCartsCartReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartReq -[internal](../modules/internal-30.md).StorePostCartsCartReq +[internal](../modules/internal-32.md).StorePostCartsCartReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:97 +medusa/dist/api/routes/store/carts/update-cart.d.ts:127 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:102 +medusa/dist/api/routes/store/carts/update-cart.d.ts:132 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:95 +medusa/dist/api/routes/store/carts/update-cart.d.ts:125 ___ @@ -40,17 +40,17 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:101 +medusa/dist/api/routes/store/carts/update-cart.d.ts:131 ___ ### discounts -• `Optional` **discounts**: [`Discount`](internal-30.Discount.md)[] +• `Optional` **discounts**: [`Discount`](internal-32.Discount.md)[] #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:100 +medusa/dist/api/routes/store/carts/update-cart.d.ts:130 ___ @@ -60,17 +60,17 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:96 +medusa/dist/api/routes/store/carts/update-cart.d.ts:126 ___ ### gift\_cards -• `Optional` **gift\_cards**: [`GiftCard`](internal-30.GiftCard.md)[] +• `Optional` **gift\_cards**: [`GiftCard`](internal-32.GiftCard.md)[] #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:99 +medusa/dist/api/routes/store/carts/update-cart.d.ts:129 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:94 +medusa/dist/api/routes/store/carts/update-cart.d.ts:124 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:103 +medusa/dist/api/routes/store/carts/update-cart.d.ts:133 ___ @@ -100,4 +100,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/update-cart.d.ts:98 +medusa/dist/api/routes/store/carts/update-cart.d.ts:128 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartShippingMethodReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCartsCartShippingMethodReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-30.StorePostCartsCartShippingMethodReq.md rename to docs/content/references/js-client/classes/internal-32.StorePostCartsCartShippingMethodReq.md index a0e2622bd7..295f76262c 100644 --- a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartShippingMethodReq.md +++ b/docs/content/references/js-client/classes/internal-32.StorePostCartsCartShippingMethodReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartShippingMethodReq -[internal](../modules/internal-30.md).StorePostCartsCartShippingMethodReq +[internal](../modules/internal-32.md).StorePostCartsCartShippingMethodReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:26 +medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:56 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:25 +medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:55 diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCustomersReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCustomersReq.md deleted file mode 100644 index f1a1f0d0bc..0000000000 --- a/docs/content/references/js-client/classes/internal-32.StorePostCustomersReq.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: StorePostCustomersReq - -[internal](../modules/internal-32.md).StorePostCustomersReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:69 - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:67 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:68 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:70 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:71 diff --git a/docs/content/references/js-client/classes/internal-31.StoreGetCollectionsParams.md b/docs/content/references/js-client/classes/internal-33.StoreGetCollectionsParams.md similarity index 58% rename from docs/content/references/js-client/classes/internal-31.StoreGetCollectionsParams.md rename to docs/content/references/js-client/classes/internal-33.StoreGetCollectionsParams.md index c97bff74a4..146d22e05b 100644 --- a/docs/content/references/js-client/classes/internal-31.StoreGetCollectionsParams.md +++ b/docs/content/references/js-client/classes/internal-33.StoreGetCollectionsParams.md @@ -1,6 +1,6 @@ # Class: StoreGetCollectionsParams -[internal](../modules/internal-31.md).StoreGetCollectionsParams +[internal](../modules/internal-33.md).StoreGetCollectionsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:82 +medusa/dist/api/routes/store/collections/list-collections.d.ts:106 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:80 +medusa/dist/api/routes/store/collections/list-collections.d.ts:104 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:81 +medusa/dist/api/routes/store/collections/list-collections.d.ts:105 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:83 +medusa/dist/api/routes/store/collections/list-collections.d.ts:107 diff --git a/docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md b/docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md similarity index 55% rename from docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md rename to docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md index 8c275c08f3..08a5cac49d 100644 --- a/docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md @@ -1,12 +1,12 @@ # Class: StoreGetCustomersCustomerOrdersPaginationParams -[internal](../modules/internal-32.md).StoreGetCustomersCustomerOrdersPaginationParams +[internal](../modules/internal-34.md).StoreGetCustomersCustomerOrdersPaginationParams ## Hierarchy - **`StoreGetCustomersCustomerOrdersPaginationParams`** - ↳ [`StoreGetCustomersCustomerOrdersParams`](internal-32.StoreGetCustomersCustomerOrdersParams.md) + ↳ [`StoreGetCustomersCustomerOrdersParams`](internal-34.StoreGetCustomersCustomerOrdersParams.md) ## Properties @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:58 +medusa/dist/api/routes/store/customers/list-orders.d.ts:184 ___ @@ -26,7 +26,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:57 +medusa/dist/api/routes/store/customers/list-orders.d.ts:183 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:55 +medusa/dist/api/routes/store/customers/list-orders.d.ts:181 ___ @@ -46,4 +46,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:56 +medusa/dist/api/routes/store/customers/list-orders.d.ts:182 diff --git a/docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersParams.md b/docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersParams.md similarity index 56% rename from docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersParams.md rename to docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersParams.md index 52f8813d33..8b915951b9 100644 --- a/docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersParams.md +++ b/docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersParams.md @@ -1,10 +1,10 @@ # Class: StoreGetCustomersCustomerOrdersParams -[internal](../modules/internal-32.md).StoreGetCustomersCustomerOrdersParams +[internal](../modules/internal-34.md).StoreGetCustomersCustomerOrdersParams ## Hierarchy -- [`StoreGetCustomersCustomerOrdersPaginationParams`](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md) +- [`StoreGetCustomersCustomerOrdersPaginationParams`](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md) ↳ **`StoreGetCustomersCustomerOrdersParams`** @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:74 +medusa/dist/api/routes/store/customers/list-orders.d.ts:200 ___ @@ -26,7 +26,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:67 +medusa/dist/api/routes/store/customers/list-orders.d.ts:193 ___ @@ -36,7 +36,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:72 +medusa/dist/api/routes/store/customers/list-orders.d.ts:198 ___ @@ -46,7 +46,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:70 +medusa/dist/api/routes/store/customers/list-orders.d.ts:196 ___ @@ -56,7 +56,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:66 +medusa/dist/api/routes/store/customers/list-orders.d.ts:192 ___ @@ -66,7 +66,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:68 +medusa/dist/api/routes/store/customers/list-orders.d.ts:194 ___ @@ -76,11 +76,11 @@ ___ #### Inherited from -[StoreGetCustomersCustomerOrdersPaginationParams](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md).[expand](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md#expand) +[StoreGetCustomersCustomerOrdersPaginationParams](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md).[expand](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md#expand) #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:58 +medusa/dist/api/routes/store/customers/list-orders.d.ts:184 ___ @@ -90,11 +90,11 @@ ___ #### Inherited from -[StoreGetCustomersCustomerOrdersPaginationParams](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md).[fields](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md#fields) +[StoreGetCustomersCustomerOrdersPaginationParams](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md).[fields](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md#fields) #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:57 +medusa/dist/api/routes/store/customers/list-orders.d.ts:183 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:64 +medusa/dist/api/routes/store/customers/list-orders.d.ts:190 ___ @@ -114,7 +114,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:61 +medusa/dist/api/routes/store/customers/list-orders.d.ts:187 ___ @@ -124,11 +124,11 @@ ___ #### Inherited from -[StoreGetCustomersCustomerOrdersPaginationParams](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md).[limit](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md#limit) +[StoreGetCustomersCustomerOrdersPaginationParams](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md).[limit](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md#limit) #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:55 +medusa/dist/api/routes/store/customers/list-orders.d.ts:181 ___ @@ -138,11 +138,11 @@ ___ #### Inherited from -[StoreGetCustomersCustomerOrdersPaginationParams](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md).[offset](internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md#offset) +[StoreGetCustomersCustomerOrdersPaginationParams](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md).[offset](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md#offset) #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:56 +medusa/dist/api/routes/store/customers/list-orders.d.ts:182 ___ @@ -152,7 +152,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:65 +medusa/dist/api/routes/store/customers/list-orders.d.ts:191 ___ @@ -162,7 +162,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:62 +medusa/dist/api/routes/store/customers/list-orders.d.ts:188 ___ @@ -172,7 +172,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:69 +medusa/dist/api/routes/store/customers/list-orders.d.ts:195 ___ @@ -182,7 +182,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:63 +medusa/dist/api/routes/store/customers/list-orders.d.ts:189 ___ @@ -192,7 +192,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:71 +medusa/dist/api/routes/store/customers/list-orders.d.ts:197 ___ @@ -202,4 +202,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/list-orders.d.ts:73 +medusa/dist/api/routes/store/customers/list-orders.d.ts:199 diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md b/docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md similarity index 74% rename from docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md rename to docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md index b3358e2fcd..91589cb218 100644 --- a/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md +++ b/docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md @@ -1,6 +1,6 @@ # Class: StorePostCustomersCustomerPasswordTokenReq -[internal](../modules/internal-32.md).StorePostCustomersCustomerPasswordTokenReq +[internal](../modules/internal-34.md).StorePostCustomersCustomerPasswordTokenReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/store/customers/reset-password-token.d.ts:26 +medusa/dist/api/routes/store/customers/reset-password-token.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerReq.md similarity index 57% rename from docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerReq.md rename to docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerReq.md index 12e3c2db30..6a0cb66d1a 100644 --- a/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerReq.md +++ b/docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerReq.md @@ -1,6 +1,6 @@ # Class: StorePostCustomersCustomerReq -[internal](../modules/internal-32.md).StorePostCustomersCustomerReq +[internal](../modules/internal-34.md).StorePostCustomersCustomerReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/customers/update-customer.d.ts:53 +medusa/dist/api/routes/store/customers/update-customer.d.ts:89 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/update-customer.d.ts:58 +medusa/dist/api/routes/store/customers/update-customer.d.ts:94 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/update-customer.d.ts:54 +medusa/dist/api/routes/store/customers/update-customer.d.ts:90 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/update-customer.d.ts:55 +medusa/dist/api/routes/store/customers/update-customer.d.ts:91 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/update-customer.d.ts:59 +medusa/dist/api/routes/store/customers/update-customer.d.ts:95 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/update-customer.d.ts:56 +medusa/dist/api/routes/store/customers/update-customer.d.ts:92 ___ @@ -70,4 +70,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/customers/update-customer.d.ts:57 +medusa/dist/api/routes/store/customers/update-customer.d.ts:93 diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCustomersReq.md b/docs/content/references/js-client/classes/internal-34.StorePostCustomersReq.md new file mode 100644 index 0000000000..0fee638fc9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-34.StorePostCustomersReq.md @@ -0,0 +1,53 @@ +# Class: StorePostCustomersReq + +[internal](../modules/internal-34.md).StorePostCustomersReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:103 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:101 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:102 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:104 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:105 diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCustomersResetPasswordReq.md b/docs/content/references/js-client/classes/internal-34.StorePostCustomersResetPasswordReq.md new file mode 100644 index 0000000000..a1243a1d86 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-34.StorePostCustomersResetPasswordReq.md @@ -0,0 +1,33 @@ +# Class: StorePostCustomersResetPasswordReq + +[internal](../modules/internal-34.md).StorePostCustomersResetPasswordReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/reset-password.d.ts:77 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/reset-password.d.ts:79 + +___ + +### token + +• **token**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/reset-password.d.ts:78 diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsItemReq.md b/docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsItemReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsItemReq.md rename to docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsItemReq.md index 454704df6c..b6b4b2e2e2 100644 --- a/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsItemReq.md +++ b/docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsItemReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartLineItemsItemReq -[internal](../modules/internal-34.md).StorePostCartsCartLineItemsItemReq +[internal](../modules/internal-36.md).StorePostCartsCartLineItemsItemReq ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/store/carts/update-line-item.d.ts:25 +medusa/dist/api/routes/store/carts/update-line-item.d.ts:55 diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsReq.md b/docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsReq.md rename to docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsReq.md index 78018f29e6..0c076c9e80 100644 --- a/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsReq.md +++ b/docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartLineItemsReq -[internal](../modules/internal-34.md).StorePostCartsCartLineItemsReq +[internal](../modules/internal-36.md).StorePostCartsCartLineItemsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/carts/create-line-item.d.ts:29 +medusa/dist/api/routes/store/carts/create-line-item.d.ts:61 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/create-line-item.d.ts:28 +medusa/dist/api/routes/store/carts/create-line-item.d.ts:60 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/create-line-item.d.ts:27 +medusa/dist/api/routes/store/carts/create-line-item.d.ts:59 diff --git a/docs/content/references/js-client/classes/internal-37.StorePostOrderEditsOrderEditDecline.md b/docs/content/references/js-client/classes/internal-37.StorePostOrderEditsOrderEditDecline.md new file mode 100644 index 0000000000..2191c50298 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-37.StorePostOrderEditsOrderEditDecline.md @@ -0,0 +1,13 @@ +# Class: StorePostOrderEditsOrderEditDecline + +[internal](../modules/internal-37.md).StorePostOrderEditsOrderEditDecline + +## Properties + +### declined\_reason + +• `Optional` **declined\_reason**: `string` + +#### Defined in + +medusa/dist/api/routes/store/order-edits/decline-order-edit.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal-35.ShippingAddressPayload.md b/docs/content/references/js-client/classes/internal-38.ShippingAddressPayload.md similarity index 51% rename from docs/content/references/js-client/classes/internal-35.ShippingAddressPayload.md rename to docs/content/references/js-client/classes/internal-38.ShippingAddressPayload.md index 093a0ddff9..455269096d 100644 --- a/docs/content/references/js-client/classes/internal-35.ShippingAddressPayload.md +++ b/docs/content/references/js-client/classes/internal-38.ShippingAddressPayload.md @@ -1,6 +1,6 @@ # Class: ShippingAddressPayload -[internal](../modules/internal-35.md).ShippingAddressPayload +[internal](../modules/internal-38.md).ShippingAddressPayload ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/store/orders/lookup-order.d.ts:43 +medusa/dist/api/routes/store/orders/lookup-order.d.ts:70 diff --git a/docs/content/references/js-client/classes/internal-35.StoreGetOrdersParams.md b/docs/content/references/js-client/classes/internal-38.StoreGetOrdersParams.md similarity index 51% rename from docs/content/references/js-client/classes/internal-35.StoreGetOrdersParams.md rename to docs/content/references/js-client/classes/internal-38.StoreGetOrdersParams.md index c031fd4de7..ff758051dc 100644 --- a/docs/content/references/js-client/classes/internal-35.StoreGetOrdersParams.md +++ b/docs/content/references/js-client/classes/internal-38.StoreGetOrdersParams.md @@ -1,6 +1,6 @@ # Class: StoreGetOrdersParams -[internal](../modules/internal-35.md).StoreGetOrdersParams +[internal](../modules/internal-38.md).StoreGetOrdersParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/orders/lookup-order.d.ts:46 +medusa/dist/api/routes/store/orders/lookup-order.d.ts:73 ___ @@ -20,14 +20,14 @@ ___ #### Defined in -medusa/dist/api/routes/store/orders/lookup-order.d.ts:47 +medusa/dist/api/routes/store/orders/lookup-order.d.ts:74 ___ ### shipping\_address -• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal-35.ShippingAddressPayload.md) +• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal-38.ShippingAddressPayload.md) #### Defined in -medusa/dist/api/routes/store/orders/lookup-order.d.ts:48 +medusa/dist/api/routes/store/orders/lookup-order.d.ts:75 diff --git a/docs/content/references/js-client/classes/internal-38.StoreGetProductsParams.md b/docs/content/references/js-client/classes/internal-38.StoreGetProductsParams.md deleted file mode 100644 index d1f54785f6..0000000000 --- a/docs/content/references/js-client/classes/internal-38.StoreGetProductsParams.md +++ /dev/null @@ -1,217 +0,0 @@ -# Class: StoreGetProductsParams - -[internal](../modules/internal-38.md).StoreGetProductsParams - -## Hierarchy - -- [`StoreGetProductsPaginationParams`](internal-38.StoreGetProductsPaginationParams.md) - - ↳ **`StoreGetProductsParams`** - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[cart_id](internal-38.StoreGetProductsPaginationParams.md#cart_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:2 - -___ - -### collection\_id - -• `Optional` **collection\_id**: `string`[] - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:126 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:133 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[currency_code](internal-38.StoreGetProductsPaginationParams.md#currency_code) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:4 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:129 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[expand](internal-38.StoreGetProductsPaginationParams.md#expand) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:119 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[fields](internal-38.StoreGetProductsPaginationParams.md#fields) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:118 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:130 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:124 - -___ - -### is\_giftcard - -• `Optional` **is\_giftcard**: `boolean` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:131 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[limit](internal-38.StoreGetProductsPaginationParams.md#limit) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:121 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[offset](internal-38.StoreGetProductsPaginationParams.md#offset) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:120 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:125 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[region_id](internal-38.StoreGetProductsPaginationParams.md#region_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:3 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:127 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:128 - -___ - -### type - -• `Optional` **type**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:132 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:134 diff --git a/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md b/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md new file mode 100644 index 0000000000..b82fda489f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md @@ -0,0 +1,67 @@ +# Class: AdminGetCurrenciesParams + +[internal](../modules/internal-4.md).AdminGetCurrenciesParams + +## Hierarchy + +- [`FindPaginationParams`](internal-4.FindPaginationParams.md) + + ↳ **`AdminGetCurrenciesParams`** + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:42 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:43 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[FindPaginationParams](internal-4.FindPaginationParams.md).[limit](internal-4.FindPaginationParams.md#limit) + +#### Defined in + +medusa/dist/types/common.d.ts:122 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[FindPaginationParams](internal-4.FindPaginationParams.md).[offset](internal-4.FindPaginationParams.md#offset) + +#### Defined in + +medusa/dist/types/common.d.ts:121 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:44 diff --git a/docs/content/references/js-client/classes/internal-4.AdminGetCustomersParams.md b/docs/content/references/js-client/classes/internal-4.AdminGetCustomersParams.md deleted file mode 100644 index 7d96417bcb..0000000000 --- a/docs/content/references/js-client/classes/internal-4.AdminGetCustomersParams.md +++ /dev/null @@ -1,67 +0,0 @@ -# Class: AdminGetCustomersParams - -[internal](../modules/internal-4.md).AdminGetCustomersParams - -## Hierarchy - -- [`AdminListCustomerSelector`](internal-4.AdminListCustomerSelector.md) - - ↳ **`AdminGetCustomersParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/list-customers.d.ts:42 - -___ - -### groups - -• `Optional` **groups**: `string`[] - -#### Inherited from - -[AdminListCustomerSelector](internal-4.AdminListCustomerSelector.md).[groups](internal-4.AdminListCustomerSelector.md#groups) - -#### Defined in - -medusa/dist/types/customers.d.ts:4 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/customers/list-customers.d.ts:40 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/customers/list-customers.d.ts:41 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[AdminListCustomerSelector](internal-4.AdminListCustomerSelector.md).[q](internal-4.AdminListCustomerSelector.md#q) - -#### Defined in - -medusa/dist/types/customers.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md b/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md new file mode 100644 index 0000000000..c601ed79be --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostCurrenciesCurrencyReq + +[internal](../modules/internal-4.md).AdminPostCurrenciesCurrencyReq + +## Properties + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/currencies/update-currency.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md b/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md new file mode 100644 index 0000000000..29e26714b9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md @@ -0,0 +1,29 @@ +# Class: FindPaginationParams + +[internal](../modules/internal-4.md).FindPaginationParams + +## Hierarchy + +- **`FindPaginationParams`** + + ↳ [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/types/common.d.ts:122 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/types/common.d.ts:121 diff --git a/docs/content/references/js-client/classes/internal-37.PriceSelectionParams.md b/docs/content/references/js-client/classes/internal-40.PriceSelectionParams.md similarity index 72% rename from docs/content/references/js-client/classes/internal-37.PriceSelectionParams.md rename to docs/content/references/js-client/classes/internal-40.PriceSelectionParams.md index 6636bf95dc..bd4ae2aa04 100644 --- a/docs/content/references/js-client/classes/internal-37.PriceSelectionParams.md +++ b/docs/content/references/js-client/classes/internal-40.PriceSelectionParams.md @@ -1,14 +1,14 @@ # Class: PriceSelectionParams -[internal](../modules/internal-37.md).PriceSelectionParams +[internal](../modules/internal-40.md).PriceSelectionParams ## Hierarchy - **`PriceSelectionParams`** - ↳ [`StoreGetVariantsParams`](internal-37.StoreGetVariantsParams.md) + ↳ [`StoreGetVariantsParams`](internal-40.StoreGetVariantsParams.md) - ↳ [`StoreGetProductsPaginationParams`](internal-38.StoreGetProductsPaginationParams.md) + ↳ [`StoreGetProductsPaginationParams`](internal-41.StoreGetProductsPaginationParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-37.StoreGetVariantsParams.md b/docs/content/references/js-client/classes/internal-40.StoreGetVariantsParams.md similarity index 52% rename from docs/content/references/js-client/classes/internal-37.StoreGetVariantsParams.md rename to docs/content/references/js-client/classes/internal-40.StoreGetVariantsParams.md index 3ebebc4e3d..cb9d1f357e 100644 --- a/docs/content/references/js-client/classes/internal-37.StoreGetVariantsParams.md +++ b/docs/content/references/js-client/classes/internal-40.StoreGetVariantsParams.md @@ -1,10 +1,10 @@ # Class: StoreGetVariantsParams -[internal](../modules/internal-37.md).StoreGetVariantsParams +[internal](../modules/internal-40.md).StoreGetVariantsParams ## Hierarchy -- [`PriceSelectionParams`](internal-37.PriceSelectionParams.md) +- [`PriceSelectionParams`](internal-40.PriceSelectionParams.md) ↳ **`StoreGetVariantsParams`** @@ -16,7 +16,7 @@ #### Inherited from -[PriceSelectionParams](internal-37.PriceSelectionParams.md).[cart_id](internal-37.PriceSelectionParams.md#cart_id) +[PriceSelectionParams](internal-40.PriceSelectionParams.md).[cart_id](internal-40.PriceSelectionParams.md#cart_id) #### Defined in @@ -30,7 +30,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-37.PriceSelectionParams.md).[currency_code](internal-37.PriceSelectionParams.md#currency_code) +[PriceSelectionParams](internal-40.PriceSelectionParams.md).[currency_code](internal-40.PriceSelectionParams.md#currency_code) #### Defined in @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/variants/list-variants.d.ts:67 +medusa/dist/api/routes/store/variants/list-variants.d.ts:82 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/variants/list-variants.d.ts:69 +medusa/dist/api/routes/store/variants/list-variants.d.ts:84 ___ @@ -64,17 +64,17 @@ ___ #### Defined in -medusa/dist/api/routes/store/variants/list-variants.d.ts:68 +medusa/dist/api/routes/store/variants/list-variants.d.ts:83 ___ ### inventory\_quantity -• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-25.NumericalComparisonOperator.md) +• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-27.NumericalComparisonOperator.md) #### Defined in -medusa/dist/api/routes/store/variants/list-variants.d.ts:71 +medusa/dist/api/routes/store/variants/list-variants.d.ts:86 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/variants/list-variants.d.ts:65 +medusa/dist/api/routes/store/variants/list-variants.d.ts:80 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/variants/list-variants.d.ts:66 +medusa/dist/api/routes/store/variants/list-variants.d.ts:81 ___ @@ -104,7 +104,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-37.PriceSelectionParams.md).[region_id](internal-37.PriceSelectionParams.md#region_id) +[PriceSelectionParams](internal-40.PriceSelectionParams.md).[region_id](internal-40.PriceSelectionParams.md#region_id) #### Defined in @@ -118,4 +118,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/variants/list-variants.d.ts:70 +medusa/dist/api/routes/store/variants/list-variants.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal-41.ReturnShipping.md b/docs/content/references/js-client/classes/internal-41.ReturnShipping.md deleted file mode 100644 index eec66c3a9e..0000000000 --- a/docs/content/references/js-client/classes/internal-41.ReturnShipping.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ReturnShipping - -[internal](../modules/internal-41.md).ReturnShipping - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal-38.StoreGetProductsPaginationParams.md b/docs/content/references/js-client/classes/internal-41.StoreGetProductsPaginationParams.md similarity index 51% rename from docs/content/references/js-client/classes/internal-38.StoreGetProductsPaginationParams.md rename to docs/content/references/js-client/classes/internal-41.StoreGetProductsPaginationParams.md index 144d9dcce9..aa6f8e97e2 100644 --- a/docs/content/references/js-client/classes/internal-38.StoreGetProductsPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-41.StoreGetProductsPaginationParams.md @@ -1,14 +1,14 @@ # Class: StoreGetProductsPaginationParams -[internal](../modules/internal-38.md).StoreGetProductsPaginationParams +[internal](../modules/internal-41.md).StoreGetProductsPaginationParams ## Hierarchy -- [`PriceSelectionParams`](internal-37.PriceSelectionParams.md) +- [`PriceSelectionParams`](internal-40.PriceSelectionParams.md) ↳ **`StoreGetProductsPaginationParams`** - ↳↳ [`StoreGetProductsParams`](internal-38.StoreGetProductsParams.md) + ↳↳ [`StoreGetProductsParams`](internal-41.StoreGetProductsParams.md) ## Properties @@ -18,7 +18,7 @@ #### Inherited from -[PriceSelectionParams](internal-37.PriceSelectionParams.md).[cart_id](internal-37.PriceSelectionParams.md#cart_id) +[PriceSelectionParams](internal-40.PriceSelectionParams.md).[cart_id](internal-40.PriceSelectionParams.md#cart_id) #### Defined in @@ -32,7 +32,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-37.PriceSelectionParams.md).[currency_code](internal-37.PriceSelectionParams.md#currency_code) +[PriceSelectionParams](internal-40.PriceSelectionParams.md).[currency_code](internal-40.PriceSelectionParams.md#currency_code) #### Defined in @@ -46,7 +46,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/products/list-products.d.ts:119 +medusa/dist/api/routes/store/products/list-products.d.ts:143 ___ @@ -56,7 +56,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/products/list-products.d.ts:118 +medusa/dist/api/routes/store/products/list-products.d.ts:142 ___ @@ -66,7 +66,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/products/list-products.d.ts:121 +medusa/dist/api/routes/store/products/list-products.d.ts:145 ___ @@ -76,7 +76,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/products/list-products.d.ts:120 +medusa/dist/api/routes/store/products/list-products.d.ts:144 ___ @@ -86,7 +86,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-37.PriceSelectionParams.md).[region_id](internal-37.PriceSelectionParams.md#region_id) +[PriceSelectionParams](internal-40.PriceSelectionParams.md).[region_id](internal-40.PriceSelectionParams.md#region_id) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-41.StoreGetProductsParams.md b/docs/content/references/js-client/classes/internal-41.StoreGetProductsParams.md new file mode 100644 index 0000000000..3e9d1f7f70 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-41.StoreGetProductsParams.md @@ -0,0 +1,227 @@ +# Class: StoreGetProductsParams + +[internal](../modules/internal-41.md).StoreGetProductsParams + +## Hierarchy + +- [`StoreGetProductsPaginationParams`](internal-41.StoreGetProductsPaginationParams.md) + + ↳ **`StoreGetProductsParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-41.StoreGetProductsPaginationParams.md).[cart_id](internal-41.StoreGetProductsPaginationParams.md#cart_id) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:2 + +___ + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:150 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:158 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-41.StoreGetProductsPaginationParams.md).[currency_code](internal-41.StoreGetProductsPaginationParams.md#currency_code) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:4 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:153 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-41.StoreGetProductsPaginationParams.md).[expand](internal-41.StoreGetProductsPaginationParams.md#expand) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:143 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-41.StoreGetProductsPaginationParams.md).[fields](internal-41.StoreGetProductsPaginationParams.md#fields) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:142 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:154 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:148 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `boolean` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:155 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-41.StoreGetProductsPaginationParams.md).[limit](internal-41.StoreGetProductsPaginationParams.md#limit) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:145 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-41.StoreGetProductsPaginationParams.md).[offset](internal-41.StoreGetProductsPaginationParams.md#offset) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:144 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:149 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-41.StoreGetProductsPaginationParams.md).[region_id](internal-41.StoreGetProductsPaginationParams.md#region_id) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:3 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string`[] + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:157 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:151 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:152 + +___ + +### type + +• `Optional` **type**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:156 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:159 diff --git a/docs/content/references/js-client/classes/internal-41.StorePostReturnsReq.md b/docs/content/references/js-client/classes/internal-41.StorePostReturnsReq.md deleted file mode 100644 index ff414c481d..0000000000 --- a/docs/content/references/js-client/classes/internal-41.StorePostReturnsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: StorePostReturnsReq - -[internal](../modules/internal-41.md).StorePostReturnsReq - -## Properties - -### items - -• **items**: [`Item`](internal-41.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:71 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:70 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-41.ReturnShipping.md) - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:72 diff --git a/docs/content/references/js-client/classes/internal-38.StorePostSearchReq.md b/docs/content/references/js-client/classes/internal-41.StorePostSearchReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal-38.StorePostSearchReq.md rename to docs/content/references/js-client/classes/internal-41.StorePostSearchReq.md index ec781c12f8..486fe88212 100644 --- a/docs/content/references/js-client/classes/internal-38.StorePostSearchReq.md +++ b/docs/content/references/js-client/classes/internal-41.StorePostSearchReq.md @@ -1,6 +1,6 @@ # Class: StorePostSearchReq -[internal](../modules/internal-38.md).StorePostSearchReq +[internal](../modules/internal-41.md).StorePostSearchReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/products/search.d.ts:30 +medusa/dist/api/routes/store/products/search.d.ts:56 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/products/search.d.ts:29 +medusa/dist/api/routes/store/products/search.d.ts:55 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/products/search.d.ts:28 +medusa/dist/api/routes/store/products/search.d.ts:54 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/products/search.d.ts:27 +medusa/dist/api/routes/store/products/search.d.ts:53 diff --git a/docs/content/references/js-client/classes/internal-43.StorePostSwapsReq.md b/docs/content/references/js-client/classes/internal-43.StorePostSwapsReq.md deleted file mode 100644 index 35e2df5f22..0000000000 --- a/docs/content/references/js-client/classes/internal-43.StorePostSwapsReq.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: StorePostSwapsReq - -[internal](../modules/internal-43.md).StorePostSwapsReq - -## Properties - -### additional\_items - -• **additional\_items**: [`AdditionalItem`](internal-43.AdditionalItem.md)[] - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:82 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:80 - -___ - -### return\_items - -• **return\_items**: [`Item`](internal-43.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:81 - -___ - -### return\_shipping\_option - -• `Optional` **return\_shipping\_option**: `string` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:83 diff --git a/docs/content/references/js-client/classes/internal-41.Item.md b/docs/content/references/js-client/classes/internal-44.Item.md similarity index 51% rename from docs/content/references/js-client/classes/internal-41.Item.md rename to docs/content/references/js-client/classes/internal-44.Item.md index 71a4f45e3e..4327cb76e0 100644 --- a/docs/content/references/js-client/classes/internal-41.Item.md +++ b/docs/content/references/js-client/classes/internal-44.Item.md @@ -1,6 +1,6 @@ # Class: Item -[internal](../modules/internal-41.md).Item +[internal](../modules/internal-44.md).Item ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/returns/create-return.d.ts:64 +medusa/dist/api/routes/store/returns/create-return.d.ts:106 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/returns/create-return.d.ts:67 +medusa/dist/api/routes/store/returns/create-return.d.ts:109 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/returns/create-return.d.ts:65 +medusa/dist/api/routes/store/returns/create-return.d.ts:107 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/returns/create-return.d.ts:66 +medusa/dist/api/routes/store/returns/create-return.d.ts:108 diff --git a/docs/content/references/js-client/classes/internal-44.ReturnShipping.md b/docs/content/references/js-client/classes/internal-44.ReturnShipping.md new file mode 100644 index 0000000000..9263a9a85f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-44.ReturnShipping.md @@ -0,0 +1,13 @@ +# Class: ReturnShipping + +[internal](../modules/internal-44.md).ReturnShipping + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:103 diff --git a/docs/content/references/js-client/classes/internal-44.StorePostReturnsReq.md b/docs/content/references/js-client/classes/internal-44.StorePostReturnsReq.md new file mode 100644 index 0000000000..a971c2e5da --- /dev/null +++ b/docs/content/references/js-client/classes/internal-44.StorePostReturnsReq.md @@ -0,0 +1,33 @@ +# Class: StorePostReturnsReq + +[internal](../modules/internal-44.md).StorePostReturnsReq + +## Properties + +### items + +• **items**: [`Item`](internal-44.Item.md)[] + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:113 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:112 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-44.ReturnShipping.md) + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:114 diff --git a/docs/content/references/js-client/classes/internal-42.StoreGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-45.StoreGetShippingOptionsParams.md similarity index 87% rename from docs/content/references/js-client/classes/internal-42.StoreGetShippingOptionsParams.md rename to docs/content/references/js-client/classes/internal-45.StoreGetShippingOptionsParams.md index 7b00fd5297..507b556c51 100644 --- a/docs/content/references/js-client/classes/internal-42.StoreGetShippingOptionsParams.md +++ b/docs/content/references/js-client/classes/internal-45.StoreGetShippingOptionsParams.md @@ -1,6 +1,6 @@ # Class: StoreGetShippingOptionsParams -[internal](../modules/internal-42.md).StoreGetShippingOptionsParams +[internal](../modules/internal-45.md).StoreGetShippingOptionsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/shipping-options/list-options.d.ts:29 +medusa/dist/api/routes/store/shipping-options/list-options.d.ts:53 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/shipping-options/list-options.d.ts:27 +medusa/dist/api/routes/store/shipping-options/list-options.d.ts:51 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/shipping-options/list-options.d.ts:28 +medusa/dist/api/routes/store/shipping-options/list-options.d.ts:52 diff --git a/docs/content/references/js-client/classes/internal-43.AdditionalItem.md b/docs/content/references/js-client/classes/internal-46.AdditionalItem.md similarity index 50% rename from docs/content/references/js-client/classes/internal-43.AdditionalItem.md rename to docs/content/references/js-client/classes/internal-46.AdditionalItem.md index 15f407f06a..c18e7b5c91 100644 --- a/docs/content/references/js-client/classes/internal-43.AdditionalItem.md +++ b/docs/content/references/js-client/classes/internal-46.AdditionalItem.md @@ -1,6 +1,6 @@ # Class: AdditionalItem -[internal](../modules/internal-43.md).AdditionalItem +[internal](../modules/internal-46.md).AdditionalItem ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/swaps/create-swap.d.ts:77 +medusa/dist/api/routes/store/swaps/create-swap.d.ts:131 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/swaps/create-swap.d.ts:76 +medusa/dist/api/routes/store/swaps/create-swap.d.ts:130 diff --git a/docs/content/references/js-client/classes/internal-43.Item.md b/docs/content/references/js-client/classes/internal-46.Item.md similarity index 53% rename from docs/content/references/js-client/classes/internal-43.Item.md rename to docs/content/references/js-client/classes/internal-46.Item.md index ce3953375d..eb8e5055e4 100644 --- a/docs/content/references/js-client/classes/internal-43.Item.md +++ b/docs/content/references/js-client/classes/internal-46.Item.md @@ -1,6 +1,6 @@ # Class: Item -[internal](../modules/internal-43.md).Item +[internal](../modules/internal-46.md).Item ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/swaps/create-swap.d.ts:70 +medusa/dist/api/routes/store/swaps/create-swap.d.ts:124 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/swaps/create-swap.d.ts:73 +medusa/dist/api/routes/store/swaps/create-swap.d.ts:127 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/swaps/create-swap.d.ts:71 +medusa/dist/api/routes/store/swaps/create-swap.d.ts:125 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/swaps/create-swap.d.ts:72 +medusa/dist/api/routes/store/swaps/create-swap.d.ts:126 diff --git a/docs/content/references/js-client/classes/internal-46.StorePostSwapsReq.md b/docs/content/references/js-client/classes/internal-46.StorePostSwapsReq.md new file mode 100644 index 0000000000..fe7d86fdee --- /dev/null +++ b/docs/content/references/js-client/classes/internal-46.StorePostSwapsReq.md @@ -0,0 +1,43 @@ +# Class: StorePostSwapsReq + +[internal](../modules/internal-46.md).StorePostSwapsReq + +## Properties + +### additional\_items + +• **additional\_items**: [`AdditionalItem`](internal-46.AdditionalItem.md)[] + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:136 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:134 + +___ + +### return\_items + +• **return\_items**: [`Item`](internal-46.Item.md)[] + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:135 + +___ + +### return\_shipping\_option + +• `Optional` **return\_shipping\_option**: `string` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:137 diff --git a/docs/content/references/js-client/classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md b/docs/content/references/js-client/classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md similarity index 69% rename from docs/content/references/js-client/classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md rename to docs/content/references/js-client/classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md index 6a230678cb..3ec86e4bf0 100644 --- a/docs/content/references/js-client/classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md +++ b/docs/content/references/js-client/classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md @@ -1,13 +1,13 @@ # Class: AdminDeleteCustomerGroupsGroupCustomerBatchReq -[internal](../modules/internal-4.md).AdminDeleteCustomerGroupsGroupCustomerBatchReq +[internal](../modules/internal-5.md).AdminDeleteCustomerGroupsGroupCustomerBatchReq ## Properties ### customer\_ids -• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-4.CustomerGroupsBatchCustomer.md)[] +• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-5.CustomerGroupsBatchCustomer.md)[] #### Defined in -medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts:43 +medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts:88 diff --git a/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsGroupParams.md b/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsGroupParams.md similarity index 58% rename from docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsGroupParams.md rename to docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsGroupParams.md index 36c0b60b39..87a046f340 100644 --- a/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsGroupParams.md +++ b/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsGroupParams.md @@ -1,10 +1,10 @@ # Class: AdminGetCustomerGroupsGroupParams -[internal](../modules/internal-4.md).AdminGetCustomerGroupsGroupParams +[internal](../modules/internal-5.md).AdminGetCustomerGroupsGroupParams ## Hierarchy -- [`FindParams`](internal-4.FindParams.md) +- [`FindParams`](internal-5.FindParams.md) ↳ **`AdminGetCustomerGroupsGroupParams`** @@ -16,11 +16,11 @@ #### Inherited from -[FindParams](internal-4.FindParams.md).[expand](internal-4.FindParams.md#expand) +[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) #### Defined in -medusa/dist/types/common.d.ts:116 +medusa/dist/types/common.d.ts:117 ___ @@ -30,8 +30,8 @@ ___ #### Inherited from -[FindParams](internal-4.FindParams.md).[fields](internal-4.FindParams.md#fields) +[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) #### Defined in -medusa/dist/types/common.d.ts:117 +medusa/dist/types/common.d.ts:118 diff --git a/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsParams.md b/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsParams.md similarity index 63% rename from docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsParams.md rename to docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsParams.md index 55eda68756..f0a4eed949 100644 --- a/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsParams.md +++ b/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetCustomerGroupsParams -[internal](../modules/internal-4.md).AdminGetCustomerGroupsParams +[internal](../modules/internal-5.md).AdminGetCustomerGroupsParams ## Hierarchy -- [`FilterableCustomerGroupProps`](internal-4.FilterableCustomerGroupProps.md) +- [`FilterableCustomerGroupProps`](internal-5.FilterableCustomerGroupProps.md) ↳ **`AdminGetCustomerGroupsParams`** @@ -16,7 +16,7 @@ #### Inherited from -[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[created_at](internal-4.FilterableCustomerGroupProps.md#created_at) +[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[created_at](internal-5.FilterableCustomerGroupProps.md#created_at) #### Defined in @@ -30,17 +30,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:127 +medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:157 ___ ### id -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) #### Inherited from -[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[id](internal-4.FilterableCustomerGroupProps.md#id) +[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[id](internal-5.FilterableCustomerGroupProps.md#id) #### Defined in @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:126 +medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:156 ___ @@ -64,7 +64,7 @@ ___ #### Inherited from -[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[name](internal-4.FilterableCustomerGroupProps.md#name) +[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[name](internal-5.FilterableCustomerGroupProps.md#name) #### Defined in @@ -78,7 +78,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:125 +medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:155 ___ @@ -88,7 +88,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:124 +medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:154 ___ @@ -98,7 +98,7 @@ ___ #### Inherited from -[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[q](internal-4.FilterableCustomerGroupProps.md#q) +[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[q](internal-5.FilterableCustomerGroupProps.md#q) #### Defined in @@ -112,7 +112,7 @@ ___ #### Inherited from -[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[updated_at](internal-4.FilterableCustomerGroupProps.md#updated_at) +[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[updated_at](internal-5.FilterableCustomerGroupProps.md#updated_at) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-5.AdminGetCustomersParams.md b/docs/content/references/js-client/classes/internal-5.AdminGetCustomersParams.md new file mode 100644 index 0000000000..21504624a4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-5.AdminGetCustomersParams.md @@ -0,0 +1,67 @@ +# Class: AdminGetCustomersParams + +[internal](../modules/internal-5.md).AdminGetCustomersParams + +## Hierarchy + +- [`AdminListCustomerSelector`](internal-5.AdminListCustomerSelector.md) + + ↳ **`AdminGetCustomersParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/list-customers.d.ts:73 + +___ + +### groups + +• `Optional` **groups**: `string`[] + +#### Inherited from + +[AdminListCustomerSelector](internal-5.AdminListCustomerSelector.md).[groups](internal-5.AdminListCustomerSelector.md#groups) + +#### Defined in + +medusa/dist/types/customers.d.ts:4 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/customers/list-customers.d.ts:71 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/customers/list-customers.d.ts:72 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[AdminListCustomerSelector](internal-5.AdminListCustomerSelector.md).[q](internal-5.AdminListCustomerSelector.md#q) + +#### Defined in + +medusa/dist/types/customers.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal-4.AdminListCustomerSelector.md b/docs/content/references/js-client/classes/internal-5.AdminListCustomerSelector.md similarity index 71% rename from docs/content/references/js-client/classes/internal-4.AdminListCustomerSelector.md rename to docs/content/references/js-client/classes/internal-5.AdminListCustomerSelector.md index 18e97714af..0a72eaa785 100644 --- a/docs/content/references/js-client/classes/internal-4.AdminListCustomerSelector.md +++ b/docs/content/references/js-client/classes/internal-5.AdminListCustomerSelector.md @@ -1,12 +1,12 @@ # Class: AdminListCustomerSelector -[internal](../modules/internal-4.md).AdminListCustomerSelector +[internal](../modules/internal-5.md).AdminListCustomerSelector ## Hierarchy - **`AdminListCustomerSelector`** - ↳ [`AdminGetCustomersParams`](internal-4.AdminGetCustomersParams.md) + ↳ [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md b/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md similarity index 70% rename from docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md rename to docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md index 1914cc8913..02917f4673 100644 --- a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md +++ b/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md @@ -1,13 +1,13 @@ # Class: AdminPostCustomerGroupsGroupCustomersBatchReq -[internal](../modules/internal-4.md).AdminPostCustomerGroupsGroupCustomersBatchReq +[internal](../modules/internal-5.md).AdminPostCustomerGroupsGroupCustomersBatchReq ## Properties ### customer\_ids -• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-4.CustomerGroupsBatchCustomer.md)[] +• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-5.CustomerGroupsBatchCustomer.md)[] #### Defined in -medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts:43 +medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts:88 diff --git a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupReq.md b/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupReq.md similarity index 66% rename from docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupReq.md rename to docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupReq.md index 791ce6aa0e..58324a5ac4 100644 --- a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupReq.md +++ b/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupReq.md @@ -1,16 +1,16 @@ # Class: AdminPostCustomerGroupsGroupReq -[internal](../modules/internal-4.md).AdminPostCustomerGroupsGroupReq +[internal](../modules/internal-5.md).AdminPostCustomerGroupsGroupReq ## Properties ### metadata -• `Optional` **metadata**: `object` +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:37 +medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:74 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:36 +medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:73 diff --git a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsReq.md b/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsReq.md similarity index 64% rename from docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsReq.md rename to docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsReq.md index ba70fdcfaf..3ba947f21b 100644 --- a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsReq.md +++ b/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsReq.md @@ -1,16 +1,16 @@ # Class: AdminPostCustomerGroupsReq -[internal](../modules/internal-4.md).AdminPostCustomerGroupsReq +[internal](../modules/internal-5.md).AdminPostCustomerGroupsReq ## Properties ### metadata -• `Optional` **metadata**: `object` +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:27 +medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:64 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:26 +medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:63 diff --git a/docs/content/references/js-client/classes/internal-5.AdminPostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal-5.AdminPostCustomersCustomerReq.md deleted file mode 100644 index f68968a690..0000000000 --- a/docs/content/references/js-client/classes/internal-5.AdminPostCustomersCustomerReq.md +++ /dev/null @@ -1,73 +0,0 @@ -# Class: AdminPostCustomersCustomerReq - -[internal](../modules/internal-5.md).AdminPostCustomersCustomerReq - -## Properties - -### email - -• `Optional` **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:64 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:65 - -___ - -### groups - -• `Optional` **groups**: [`Group`](internal-5.Group.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:70 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:66 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:69 - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:67 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-4.CustomerGroupsBatchCustomer.md b/docs/content/references/js-client/classes/internal-5.CustomerGroupsBatchCustomer.md similarity index 69% rename from docs/content/references/js-client/classes/internal-4.CustomerGroupsBatchCustomer.md rename to docs/content/references/js-client/classes/internal-5.CustomerGroupsBatchCustomer.md index 9271db5c44..23c70f4e73 100644 --- a/docs/content/references/js-client/classes/internal-4.CustomerGroupsBatchCustomer.md +++ b/docs/content/references/js-client/classes/internal-5.CustomerGroupsBatchCustomer.md @@ -1,6 +1,6 @@ # Class: CustomerGroupsBatchCustomer -[internal](../modules/internal-4.md).CustomerGroupsBatchCustomer +[internal](../modules/internal-5.md).CustomerGroupsBatchCustomer ## Properties diff --git a/docs/content/references/js-client/classes/internal-4.FilterableCustomerGroupProps.md b/docs/content/references/js-client/classes/internal-5.FilterableCustomerGroupProps.md similarity index 82% rename from docs/content/references/js-client/classes/internal-4.FilterableCustomerGroupProps.md rename to docs/content/references/js-client/classes/internal-5.FilterableCustomerGroupProps.md index 3c79b179bf..75f28f0afd 100644 --- a/docs/content/references/js-client/classes/internal-4.FilterableCustomerGroupProps.md +++ b/docs/content/references/js-client/classes/internal-5.FilterableCustomerGroupProps.md @@ -1,12 +1,12 @@ # Class: FilterableCustomerGroupProps -[internal](../modules/internal-4.md).FilterableCustomerGroupProps +[internal](../modules/internal-5.md).FilterableCustomerGroupProps ## Hierarchy - **`FilterableCustomerGroupProps`** - ↳ [`AdminGetCustomerGroupsParams`](internal-4.AdminGetCustomerGroupsParams.md) + ↳ [`AdminGetCustomerGroupsParams`](internal-5.AdminGetCustomerGroupsParams.md) ## Properties @@ -22,7 +22,7 @@ ___ ### id -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-4.FindParams.md b/docs/content/references/js-client/classes/internal-5.FindParams.md similarity index 65% rename from docs/content/references/js-client/classes/internal-4.FindParams.md rename to docs/content/references/js-client/classes/internal-5.FindParams.md index 14a5b60563..0555402354 100644 --- a/docs/content/references/js-client/classes/internal-4.FindParams.md +++ b/docs/content/references/js-client/classes/internal-5.FindParams.md @@ -1,12 +1,12 @@ # Class: FindParams -[internal](../modules/internal-4.md).FindParams +[internal](../modules/internal-5.md).FindParams ## Hierarchy - **`FindParams`** - ↳ [`AdminGetCustomerGroupsGroupParams`](internal-4.AdminGetCustomerGroupsGroupParams.md) + ↳ [`AdminGetCustomerGroupsGroupParams`](internal-5.AdminGetCustomerGroupsGroupParams.md) ## Properties @@ -16,7 +16,7 @@ #### Defined in -medusa/dist/types/common.d.ts:116 +medusa/dist/types/common.d.ts:117 ___ @@ -26,4 +26,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:117 +medusa/dist/types/common.d.ts:118 diff --git a/docs/content/references/js-client/classes/internal-5.Group.md b/docs/content/references/js-client/classes/internal-5.Group.md deleted file mode 100644 index 3f3b84f55a..0000000000 --- a/docs/content/references/js-client/classes/internal-5.Group.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: Group - -[internal](../modules/internal-5.md).Group - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal-4.StringComparisonOperator.md b/docs/content/references/js-client/classes/internal-5.StringComparisonOperator.md similarity index 80% rename from docs/content/references/js-client/classes/internal-4.StringComparisonOperator.md rename to docs/content/references/js-client/classes/internal-5.StringComparisonOperator.md index cf2a8d1503..e8cb2cc19f 100644 --- a/docs/content/references/js-client/classes/internal-4.StringComparisonOperator.md +++ b/docs/content/references/js-client/classes/internal-5.StringComparisonOperator.md @@ -1,6 +1,6 @@ # Class: StringComparisonOperator -[internal](../modules/internal-4.md).StringComparisonOperator +[internal](../modules/internal-5.md).StringComparisonOperator ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/types/common.d.ts:79 +medusa/dist/types/common.d.ts:80 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:80 +medusa/dist/types/common.d.ts:81 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:78 +medusa/dist/types/common.d.ts:79 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:81 +medusa/dist/types/common.d.ts:82 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal-6.AdminPostCustomersCustomerReq.md new file mode 100644 index 0000000000..8b304fe5f6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminPostCustomersCustomerReq.md @@ -0,0 +1,73 @@ +# Class: AdminPostCustomersCustomerReq + +[internal](../modules/internal-6.md).AdminPostCustomersCustomerReq + +## Properties + +### email + +• `Optional` **email**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:101 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:102 + +___ + +### groups + +• `Optional` **groups**: [`Group`](internal-6.Group.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:107 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:103 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:106 + +___ + +### password + +• `Optional` **password**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:104 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:105 diff --git a/docs/content/references/js-client/classes/internal-5.AdminPostCustomersReq.md b/docs/content/references/js-client/classes/internal-6.AdminPostCustomersReq.md similarity index 51% rename from docs/content/references/js-client/classes/internal-5.AdminPostCustomersReq.md rename to docs/content/references/js-client/classes/internal-6.AdminPostCustomersReq.md index 1c9ec126ba..ceeca954cc 100644 --- a/docs/content/references/js-client/classes/internal-5.AdminPostCustomersReq.md +++ b/docs/content/references/js-client/classes/internal-6.AdminPostCustomersReq.md @@ -1,6 +1,6 @@ # Class: AdminPostCustomersReq -[internal](../modules/internal-5.md).AdminPostCustomersReq +[internal](../modules/internal-6.md).AdminPostCustomersReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/customers/create-customer.d.ts:52 +medusa/dist/api/routes/admin/customers/create-customer.d.ts:95 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customers/create-customer.d.ts:53 +medusa/dist/api/routes/admin/customers/create-customer.d.ts:96 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customers/create-customer.d.ts:54 +medusa/dist/api/routes/admin/customers/create-customer.d.ts:97 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customers/create-customer.d.ts:57 +medusa/dist/api/routes/admin/customers/create-customer.d.ts:100 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customers/create-customer.d.ts:55 +medusa/dist/api/routes/admin/customers/create-customer.d.ts:98 ___ @@ -60,4 +60,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/customers/create-customer.d.ts:56 +medusa/dist/api/routes/admin/customers/create-customer.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal-6.Group.md b/docs/content/references/js-client/classes/internal-6.Group.md new file mode 100644 index 0000000000..9111ddb4f9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.Group.md @@ -0,0 +1,13 @@ +# Class: Group + +[internal](../modules/internal-6.md).Group + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:98 diff --git a/docs/content/references/js-client/classes/internal-6.AdminCreateCondition.md b/docs/content/references/js-client/classes/internal-7.AdminCreateCondition.md similarity index 55% rename from docs/content/references/js-client/classes/internal-6.AdminCreateCondition.md rename to docs/content/references/js-client/classes/internal-7.AdminCreateCondition.md index 9a99b1f509..ed2481ba28 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminCreateCondition.md +++ b/docs/content/references/js-client/classes/internal-7.AdminCreateCondition.md @@ -1,10 +1,10 @@ # Class: AdminCreateCondition -[internal](../modules/internal-6.md).AdminCreateCondition +[internal](../modules/internal-7.md).AdminCreateCondition ## Hierarchy -- [`AdminUpsertConditionsReq`](internal-6.AdminUpsertConditionsReq.md) +- [`AdminUpsertConditionsReq`](internal-7.AdminUpsertConditionsReq.md) ↳ **`AdminCreateCondition`** @@ -16,7 +16,7 @@ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[customer_groups](internal-6.AdminUpsertConditionsReq.md#customer_groups) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[customer_groups](internal-7.AdminUpsertConditionsReq.md#customer_groups) #### Defined in @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:147 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:197 ___ @@ -40,7 +40,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_collections](internal-6.AdminUpsertConditionsReq.md#product_collections) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_collections](internal-7.AdminUpsertConditionsReq.md#product_collections) #### Defined in @@ -54,7 +54,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_tags](internal-6.AdminUpsertConditionsReq.md#product_tags) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_tags](internal-7.AdminUpsertConditionsReq.md#product_tags) #### Defined in @@ -68,7 +68,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_types](internal-6.AdminUpsertConditionsReq.md#product_types) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_types](internal-7.AdminUpsertConditionsReq.md#product_types) #### Defined in @@ -82,7 +82,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[products](internal-6.AdminUpsertConditionsReq.md#products) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[products](internal-7.AdminUpsertConditionsReq.md#products) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md b/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md similarity index 56% rename from docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md rename to docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md index a4206e95d3..8a73cc3604 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md +++ b/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md @@ -1,6 +1,6 @@ # Class: AdminGetDiscountsDiscountConditionsConditionParams -[internal](../modules/internal-6.md).AdminGetDiscountsDiscountConditionsConditionParams +[internal](../modules/internal-7.md).AdminGetDiscountsDiscountConditionsConditionParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/get-condition.d.ts:28 +medusa/dist/api/routes/admin/discounts/get-condition.d.ts:58 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/get-condition.d.ts:29 +medusa/dist/api/routes/admin/discounts/get-condition.d.ts:59 diff --git a/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountRuleParams.md b/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountRuleParams.md similarity index 85% rename from docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountRuleParams.md rename to docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountRuleParams.md index 977fc42444..0646d1a543 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountRuleParams.md +++ b/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountRuleParams.md @@ -1,6 +1,6 @@ # Class: AdminGetDiscountsDiscountRuleParams -[internal](../modules/internal-6.md).AdminGetDiscountsDiscountRuleParams +[internal](../modules/internal-7.md).AdminGetDiscountsDiscountRuleParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsParams.md b/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsParams.md similarity index 50% rename from docs/content/references/js-client/classes/internal-6.AdminGetDiscountsParams.md rename to docs/content/references/js-client/classes/internal-7.AdminGetDiscountsParams.md index f42e3cf8e4..c680dbb453 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsParams.md +++ b/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetDiscountsParams -[internal](../modules/internal-6.md).AdminGetDiscountsParams +[internal](../modules/internal-7.md).AdminGetDiscountsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:61 +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:92 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:58 +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:89 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:57 +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:88 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:59 +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:90 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:60 +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:91 ___ @@ -60,14 +60,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:56 +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:87 ___ ### rule -• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal-6.AdminGetDiscountsDiscountRuleParams.md) +• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal-7.AdminGetDiscountsDiscountRuleParams.md) #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:55 +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:86 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditions.md b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditions.md similarity index 56% rename from docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditions.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditions.md index 1d58fff673..a6fd48fe0f 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditions.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditions.md @@ -1,10 +1,10 @@ # Class: AdminPostDiscountsDiscountConditions -[internal](../modules/internal-6.md).AdminPostDiscountsDiscountConditions +[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditions ## Hierarchy -- [`AdminUpsertConditionsReq`](internal-6.AdminUpsertConditionsReq.md) +- [`AdminUpsertConditionsReq`](internal-7.AdminUpsertConditionsReq.md) ↳ **`AdminPostDiscountsDiscountConditions`** @@ -16,7 +16,7 @@ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[customer_groups](internal-6.AdminUpsertConditionsReq.md#customer_groups) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[customer_groups](internal-7.AdminUpsertConditionsReq.md#customer_groups) #### Defined in @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-condition.d.ts:65 +medusa/dist/api/routes/admin/discounts/create-condition.d.ts:102 ___ @@ -40,7 +40,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_collections](internal-6.AdminUpsertConditionsReq.md#product_collections) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_collections](internal-7.AdminUpsertConditionsReq.md#product_collections) #### Defined in @@ -54,7 +54,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_tags](internal-6.AdminUpsertConditionsReq.md#product_tags) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_tags](internal-7.AdminUpsertConditionsReq.md#product_tags) #### Defined in @@ -68,7 +68,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_types](internal-6.AdminUpsertConditionsReq.md#product_types) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_types](internal-7.AdminUpsertConditionsReq.md#product_types) #### Defined in @@ -82,7 +82,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[products](internal-6.AdminUpsertConditionsReq.md#products) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[products](internal-7.AdminUpsertConditionsReq.md#products) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md similarity index 55% rename from docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md index 23ee1c751d..23ca0ae79b 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md @@ -1,10 +1,10 @@ # Class: AdminPostDiscountsDiscountConditionsCondition -[internal](../modules/internal-6.md).AdminPostDiscountsDiscountConditionsCondition +[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditionsCondition ## Hierarchy -- [`AdminUpsertConditionsReq`](internal-6.AdminUpsertConditionsReq.md) +- [`AdminUpsertConditionsReq`](internal-7.AdminUpsertConditionsReq.md) ↳ **`AdminPostDiscountsDiscountConditionsCondition`** @@ -16,7 +16,7 @@ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[customer_groups](internal-6.AdminUpsertConditionsReq.md#customer_groups) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[customer_groups](internal-7.AdminUpsertConditionsReq.md#customer_groups) #### Defined in @@ -30,7 +30,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_collections](internal-6.AdminUpsertConditionsReq.md#product_collections) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_collections](internal-7.AdminUpsertConditionsReq.md#product_collections) #### Defined in @@ -44,7 +44,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_tags](internal-6.AdminUpsertConditionsReq.md#product_tags) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_tags](internal-7.AdminUpsertConditionsReq.md#product_tags) #### Defined in @@ -58,7 +58,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_types](internal-6.AdminUpsertConditionsReq.md#product_types) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_types](internal-7.AdminUpsertConditionsReq.md#product_types) #### Defined in @@ -72,7 +72,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[products](internal-6.AdminUpsertConditionsReq.md#products) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[products](internal-7.AdminUpsertConditionsReq.md#products) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md similarity index 55% rename from docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md index 0e6f9b5d46..a0190ff320 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md @@ -1,6 +1,6 @@ # Class: AdminPostDiscountsDiscountConditionsConditionParams -[internal](../modules/internal-6.md).AdminPostDiscountsDiscountConditionsConditionParams +[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditionsConditionParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/update-condition.d.ts:60 +medusa/dist/api/routes/admin/discounts/update-condition.d.ts:101 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-condition.d.ts:61 +medusa/dist/api/routes/admin/discounts/update-condition.d.ts:102 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md similarity index 53% rename from docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md index f53c7f745d..58e9a1295a 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md @@ -1,6 +1,6 @@ # Class: AdminPostDiscountsDiscountConditionsParams -[internal](../modules/internal-6.md).AdminPostDiscountsDiscountConditionsParams +[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditionsParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/create-condition.d.ts:68 +medusa/dist/api/routes/admin/discounts/create-condition.d.ts:105 ___ @@ -20,4 +20,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-condition.d.ts:69 +medusa/dist/api/routes/admin/discounts/create-condition.d.ts:106 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md index 0bf7848a95..f21feeda2d 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostDiscountsDiscountDynamicCodesReq -[internal](../modules/internal-6.md).AdminPostDiscountsDiscountDynamicCodesReq +[internal](../modules/internal-7.md).AdminPostDiscountsDiscountDynamicCodesReq ## Properties @@ -10,17 +10,17 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:27 +medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:65 ___ ### metadata -• `Optional` **metadata**: `object` +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:29 +medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:67 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:28 +medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:66 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountReq.md b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountReq.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountReq.md index 5178ba1c3b..a669235cfc 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountReq.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountReq.md @@ -1,6 +1,6 @@ # Class: AdminPostDiscountsDiscountReq -[internal](../modules/internal-6.md).AdminPostDiscountsDiscountReq +[internal](../modules/internal-7.md).AdminPostDiscountsDiscountReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:122 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:159 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:126 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:163 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:124 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:161 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:130 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:167 ___ @@ -50,17 +50,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:129 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:166 ___ ### rule -• `Optional` **rule**: [`AdminUpdateDiscountRule`](internal-6.AdminUpdateDiscountRule.md) +• `Optional` **rule**: [`AdminUpdateDiscountRule`](internal-7.AdminUpdateDiscountRule.md) #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:123 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:160 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:125 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:162 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:128 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:165 ___ @@ -90,4 +90,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:127 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:164 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountRule.md b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountRule.md similarity index 55% rename from docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountRule.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountRule.md index 6eadc37a60..6f52b52202 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountRule.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountRule.md @@ -1,6 +1,6 @@ # Class: AdminPostDiscountsDiscountRule -[internal](../modules/internal-6.md).AdminPostDiscountsDiscountRule +[internal](../modules/internal-7.md).AdminPostDiscountsDiscountRule ## Properties @@ -10,17 +10,17 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:143 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:193 ___ ### conditions -• `Optional` **conditions**: [`AdminCreateCondition`](internal-6.AdminCreateCondition.md)[] +• `Optional` **conditions**: [`AdminCreateCondition`](internal-7.AdminCreateCondition.md)[] #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:144 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:194 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:140 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:190 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:141 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:191 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:142 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:192 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsReq.md b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsReq.md similarity index 51% rename from docs/content/references/js-client/classes/internal-6.AdminPostDiscountsReq.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDiscountsReq.md index 92d44fc7ad..909851efa5 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsReq.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostDiscountsReq -[internal](../modules/internal-6.md).AdminPostDiscountsReq +[internal](../modules/internal-7.md).AdminPostDiscountsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:128 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:178 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:133 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:183 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:131 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:181 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:130 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:180 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:137 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:187 ___ @@ -60,17 +60,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:136 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:186 ___ ### rule -• **rule**: [`AdminPostDiscountsDiscountRule`](internal-6.AdminPostDiscountsDiscountRule.md) +• **rule**: [`AdminPostDiscountsDiscountRule`](internal-7.AdminPostDiscountsDiscountRule.md) #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:129 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:179 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:132 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:182 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:135 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:185 ___ @@ -100,4 +100,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:134 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:184 diff --git a/docs/content/references/js-client/classes/internal-6.AdminUpdateDiscountRule.md b/docs/content/references/js-client/classes/internal-7.AdminUpdateDiscountRule.md similarity index 53% rename from docs/content/references/js-client/classes/internal-6.AdminUpdateDiscountRule.md rename to docs/content/references/js-client/classes/internal-7.AdminUpdateDiscountRule.md index 4b55327e74..94915fad69 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminUpdateDiscountRule.md +++ b/docs/content/references/js-client/classes/internal-7.AdminUpdateDiscountRule.md @@ -1,6 +1,6 @@ # Class: AdminUpdateDiscountRule -[internal](../modules/internal-6.md).AdminUpdateDiscountRule +[internal](../modules/internal-7.md).AdminUpdateDiscountRule ## Properties @@ -10,17 +10,17 @@ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:136 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:173 ___ ### conditions -• `Optional` **conditions**: [`AdminUpsertCondition`](internal-6.AdminUpsertCondition.md)[] +• `Optional` **conditions**: [`AdminUpsertCondition`](internal-7.AdminUpsertCondition.md)[] #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:137 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:174 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:134 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:171 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:133 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:170 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:135 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:172 diff --git a/docs/content/references/js-client/classes/internal-6.AdminUpsertCondition.md b/docs/content/references/js-client/classes/internal-7.AdminUpsertCondition.md similarity index 54% rename from docs/content/references/js-client/classes/internal-6.AdminUpsertCondition.md rename to docs/content/references/js-client/classes/internal-7.AdminUpsertCondition.md index 18e1590bc8..895733d4be 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminUpsertCondition.md +++ b/docs/content/references/js-client/classes/internal-7.AdminUpsertCondition.md @@ -1,10 +1,10 @@ # Class: AdminUpsertCondition -[internal](../modules/internal-6.md).AdminUpsertCondition +[internal](../modules/internal-7.md).AdminUpsertCondition ## Hierarchy -- [`AdminUpsertConditionsReq`](internal-6.AdminUpsertConditionsReq.md) +- [`AdminUpsertConditionsReq`](internal-7.AdminUpsertConditionsReq.md) ↳ **`AdminUpsertCondition`** @@ -16,7 +16,7 @@ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[customer_groups](internal-6.AdminUpsertConditionsReq.md#customer_groups) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[customer_groups](internal-7.AdminUpsertConditionsReq.md#customer_groups) #### Defined in @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:140 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:177 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:141 +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:178 ___ @@ -50,7 +50,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_collections](internal-6.AdminUpsertConditionsReq.md#product_collections) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_collections](internal-7.AdminUpsertConditionsReq.md#product_collections) #### Defined in @@ -64,7 +64,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_tags](internal-6.AdminUpsertConditionsReq.md#product_tags) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_tags](internal-7.AdminUpsertConditionsReq.md#product_tags) #### Defined in @@ -78,7 +78,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_types](internal-6.AdminUpsertConditionsReq.md#product_types) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_types](internal-7.AdminUpsertConditionsReq.md#product_types) #### Defined in @@ -92,7 +92,7 @@ ___ #### Inherited from -[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[products](internal-6.AdminUpsertConditionsReq.md#products) +[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[products](internal-7.AdminUpsertConditionsReq.md#products) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-6.AdminUpsertConditionsReq.md b/docs/content/references/js-client/classes/internal-7.AdminUpsertConditionsReq.md similarity index 72% rename from docs/content/references/js-client/classes/internal-6.AdminUpsertConditionsReq.md rename to docs/content/references/js-client/classes/internal-7.AdminUpsertConditionsReq.md index a91da024be..91b7ed42a2 100644 --- a/docs/content/references/js-client/classes/internal-6.AdminUpsertConditionsReq.md +++ b/docs/content/references/js-client/classes/internal-7.AdminUpsertConditionsReq.md @@ -1,18 +1,18 @@ # Class: AdminUpsertConditionsReq -[internal](../modules/internal-6.md).AdminUpsertConditionsReq +[internal](../modules/internal-7.md).AdminUpsertConditionsReq ## Hierarchy - **`AdminUpsertConditionsReq`** - ↳ [`AdminPostDiscountsDiscountConditions`](internal-6.AdminPostDiscountsDiscountConditions.md) + ↳ [`AdminPostDiscountsDiscountConditions`](internal-7.AdminPostDiscountsDiscountConditions.md) - ↳ [`AdminPostDiscountsDiscountConditionsCondition`](internal-6.AdminPostDiscountsDiscountConditionsCondition.md) + ↳ [`AdminPostDiscountsDiscountConditionsCondition`](internal-7.AdminPostDiscountsDiscountConditionsCondition.md) - ↳ [`AdminCreateCondition`](internal-6.AdminCreateCondition.md) + ↳ [`AdminCreateCondition`](internal-7.AdminCreateCondition.md) - ↳ [`AdminUpsertCondition`](internal-6.AdminUpsertCondition.md) + ↳ [`AdminUpsertCondition`](internal-7.AdminUpsertCondition.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-7.AdminGetDraftOrdersParams.md b/docs/content/references/js-client/classes/internal-8.AdminGetDraftOrdersParams.md similarity index 85% rename from docs/content/references/js-client/classes/internal-7.AdminGetDraftOrdersParams.md rename to docs/content/references/js-client/classes/internal-8.AdminGetDraftOrdersParams.md index 532c899cbc..a52b515ff3 100644 --- a/docs/content/references/js-client/classes/internal-7.AdminGetDraftOrdersParams.md +++ b/docs/content/references/js-client/classes/internal-8.AdminGetDraftOrdersParams.md @@ -1,6 +1,6 @@ # Class: AdminGetDraftOrdersParams -[internal](../modules/internal-7.md).AdminGetDraftOrdersParams +[internal](../modules/internal-8.md).AdminGetDraftOrdersParams ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:38 +medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:69 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:39 +medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:70 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:37 +medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-8.AdminGetGiftCardsParams.md b/docs/content/references/js-client/classes/internal-8.AdminGetGiftCardsParams.md deleted file mode 100644 index 48a4d46e32..0000000000 --- a/docs/content/references/js-client/classes/internal-8.AdminGetGiftCardsParams.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminGetGiftCardsParams - -[internal](../modules/internal-8.md).AdminGetGiftCardsParams - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:37 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:38 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md b/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md similarity index 89% rename from docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md rename to docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md index d7835f06fd..bd0067ee68 100644 --- a/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md +++ b/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md @@ -1,6 +1,6 @@ # Class: AdminPostDraftOrdersDraftOrderLineItemsItemReq -[internal](../modules/internal-7.md).AdminPostDraftOrdersDraftOrderLineItemsItemReq +[internal](../modules/internal-8.md).AdminPostDraftOrdersDraftOrderLineItemsItemReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:45 +medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:82 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:44 +medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:81 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:42 +medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:79 ___ @@ -40,4 +40,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:43 +medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:80 diff --git a/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md b/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md similarity index 90% rename from docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md rename to docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md index 77cab3c0f6..f2b55b248a 100644 --- a/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md +++ b/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostDraftOrdersDraftOrderLineItemsReq -[internal](../modules/internal-7.md).AdminPostDraftOrdersDraftOrderLineItemsReq +[internal](../modules/internal-8.md).AdminPostDraftOrdersDraftOrderLineItemsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:51 +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:88 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:50 +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:87 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:47 +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:84 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:48 +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:85 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:49 +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:86 diff --git a/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md b/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md similarity index 88% rename from docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md rename to docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md index 1edc1e1867..8fba1a1bf0 100644 --- a/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md +++ b/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md @@ -1,6 +1,6 @@ # Class: AdminPostDraftOrdersDraftOrderReq -[internal](../modules/internal-7.md).AdminPostDraftOrdersDraftOrderReq +[internal](../modules/internal-8.md).AdminPostDraftOrdersDraftOrderReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:69 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:106 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:67 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:104 ___ @@ -30,17 +30,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:72 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:109 ___ ### discounts -• `Optional` **discounts**: [`Discount`](internal-7.Discount.md)[] +• `Optional` **discounts**: [`Discount`](internal-8.Discount.md)[] #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:71 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:108 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:68 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:105 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:73 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:110 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:66 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:103 ___ @@ -80,4 +80,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:70 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:107 diff --git a/docs/content/references/js-client/classes/internal-7.Discount.md b/docs/content/references/js-client/classes/internal-8.Discount.md similarity index 74% rename from docs/content/references/js-client/classes/internal-7.Discount.md rename to docs/content/references/js-client/classes/internal-8.Discount.md index 591a24ba08..01bdce3225 100644 --- a/docs/content/references/js-client/classes/internal-7.Discount.md +++ b/docs/content/references/js-client/classes/internal-8.Discount.md @@ -1,6 +1,6 @@ # Class: Discount -[internal](../modules/internal-7.md).Discount +[internal](../modules/internal-8.md).Discount ## Properties @@ -10,4 +10,4 @@ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:76 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:113 diff --git a/docs/content/references/js-client/classes/internal-9.AdminGetGiftCardsParams.md b/docs/content/references/js-client/classes/internal-9.AdminGetGiftCardsParams.md new file mode 100644 index 0000000000..f50378eb64 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-9.AdminGetGiftCardsParams.md @@ -0,0 +1,33 @@ +# Class: AdminGetGiftCardsParams + +[internal](../modules/internal-9.md).AdminGetGiftCardsParams + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:68 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:69 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:70 diff --git a/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsGiftCardReq.md b/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsGiftCardReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsGiftCardReq.md rename to docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsGiftCardReq.md index 9006113eb0..4b1d1564c3 100644 --- a/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsGiftCardReq.md +++ b/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsGiftCardReq.md @@ -1,6 +1,6 @@ # Class: AdminPostGiftCardsGiftCardReq -[internal](../modules/internal-8.md).AdminPostGiftCardsGiftCardReq +[internal](../modules/internal-9.md).AdminPostGiftCardsGiftCardReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:45 +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:82 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:47 +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:84 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:46 +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:83 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:49 +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:86 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:48 +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsReq.md b/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsReq.md similarity index 53% rename from docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsReq.md rename to docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsReq.md index a107ffca26..a2a9c62568 100644 --- a/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsReq.md +++ b/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostGiftCardsReq -[internal](../modules/internal-8.md).AdminPostGiftCardsReq +[internal](../modules/internal-9.md).AdminPostGiftCardsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:46 +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:83 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:47 +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:84 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:49 +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:86 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:48 +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:85 ___ @@ -50,4 +50,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:45 +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:82 diff --git a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptReq.md b/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptReq.md deleted file mode 100644 index 634b5a6fe3..0000000000 --- a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostInvitesInviteAcceptReq - -[internal](../modules/internal-9.md).AdminPostInvitesInviteAcceptReq - -## Properties - -### token - -• **token**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:49 - -___ - -### user - -• **user**: [`AdminPostInvitesInviteAcceptUserReq`](internal-9.AdminPostInvitesInviteAcceptUserReq.md) - -#### Defined in - -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:50 diff --git a/docs/content/references/js-client/classes/internal.AddressCreatePayload.md b/docs/content/references/js-client/classes/internal.AddressCreatePayload.md index 4ca897cbeb..eecb623583 100644 --- a/docs/content/references/js-client/classes/internal.AddressCreatePayload.md +++ b/docs/content/references/js-client/classes/internal.AddressCreatePayload.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/types/common.d.ts:108 +medusa/dist/types/common.d.ts:109 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:109 +medusa/dist/types/common.d.ts:110 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:110 +medusa/dist/types/common.d.ts:111 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:107 +medusa/dist/types/common.d.ts:108 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:111 +medusa/dist/types/common.d.ts:112 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:103 +medusa/dist/types/common.d.ts:104 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:104 +medusa/dist/types/common.d.ts:105 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:106 +medusa/dist/types/common.d.ts:107 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:105 +medusa/dist/types/common.d.ts:106 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:113 +medusa/dist/types/common.d.ts:114 ___ @@ -114,4 +114,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:112 +medusa/dist/types/common.d.ts:113 diff --git a/docs/content/references/js-client/classes/internal.AddressPayload.md b/docs/content/references/js-client/classes/internal.AddressPayload.md index 3592a179ba..be8bb4050c 100644 --- a/docs/content/references/js-client/classes/internal.AddressPayload.md +++ b/docs/content/references/js-client/classes/internal.AddressPayload.md @@ -20,7 +20,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/types/common.d.ts:95 +medusa/dist/types/common.d.ts:96 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:96 +medusa/dist/types/common.d.ts:97 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:97 +medusa/dist/types/common.d.ts:98 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:94 +medusa/dist/types/common.d.ts:95 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:98 +medusa/dist/types/common.d.ts:99 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:90 +medusa/dist/types/common.d.ts:91 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:91 +medusa/dist/types/common.d.ts:92 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:93 +medusa/dist/types/common.d.ts:94 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:92 +medusa/dist/types/common.d.ts:93 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:100 +medusa/dist/types/common.d.ts:101 ___ @@ -120,4 +120,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:99 +medusa/dist/types/common.d.ts:100 diff --git a/docs/content/references/js-client/classes/internal.BaseEntity.md b/docs/content/references/js-client/classes/internal.BaseEntity.md index 5a995606da..5fb341861b 100644 --- a/docs/content/references/js-client/classes/internal.BaseEntity.md +++ b/docs/content/references/js-client/classes/internal.BaseEntity.md @@ -26,6 +26,8 @@ Base abstract entity for all entities ↳ [`DraftOrder`](internal.DraftOrder.md) + ↳ [`OrderEdit`](internal.OrderEdit.md) + ↳ [`LineItem`](internal.LineItem.md) ↳ [`PaymentSession`](internal.PaymentSession.md) @@ -34,9 +36,9 @@ Base abstract entity for all entities ↳ [`TaxLine`](internal.TaxLine.md) - ↳ [`Notification`](internal-11.Notification.md) + ↳ [`Notification`](internal-12.Notification.md) - ↳ [`Store`](internal-23.Store.md) + ↳ [`Store`](internal-25.Store.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal.Client.md b/docs/content/references/js-client/classes/internal.Client.md index 640765386c..906004ff79 100644 --- a/docs/content/references/js-client/classes/internal.Client.md +++ b/docs/content/references/js-client/classes/internal.Client.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -[medusa-js/src/request.ts:29](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L29) +[medusa-js/src/request.ts:29](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:30](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L30) +[medusa-js/src/request.ts:30](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L30) ## Methods @@ -48,7 +48,7 @@ and the exponential backoff approach. #### Defined in -[medusa-js/src/request.ts:146](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L146) +[medusa-js/src/request.ts:146](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L146) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:83](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L83) +[medusa-js/src/request.ts:83](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L83) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:71](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L71) +[medusa-js/src/request.ts:71](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L71) ___ @@ -114,7 +114,7 @@ Axios request #### Defined in -[medusa-js/src/request.ts:183](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L183) +[medusa-js/src/request.ts:183](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L183) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:92](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L92) +[medusa-js/src/request.ts:92](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L92) ___ @@ -161,7 +161,7 @@ We add the idempotency key, if the request is configured to retry. #### Defined in -[medusa-js/src/request.ts:108](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L108) +[medusa-js/src/request.ts:108](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L108) ___ @@ -183,4 +183,4 @@ ___ #### Defined in -[medusa-js/src/request.ts:40](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L40) +[medusa-js/src/request.ts:40](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L40) diff --git a/docs/content/references/js-client/classes/internal.Currency.md b/docs/content/references/js-client/classes/internal.Currency.md index ca33db08b7..5ed52ff837 100644 --- a/docs/content/references/js-client/classes/internal.Currency.md +++ b/docs/content/references/js-client/classes/internal.Currency.md @@ -18,6 +18,16 @@ medusa/dist/models/currency.d.ts:2 ___ +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/models/currency.d.ts:6 + +___ + ### name • **name**: `string` diff --git a/docs/content/references/js-client/classes/internal.LineItem.md b/docs/content/references/js-client/classes/internal.LineItem.md index f14ff05164..3125ce2f46 100644 --- a/docs/content/references/js-client/classes/internal.LineItem.md +++ b/docs/content/references/js-client/classes/internal.LineItem.md @@ -22,7 +22,7 @@ Base abstract entity for all entities #### Defined in -medusa/dist/models/line-item.d.ts:19 +medusa/dist/models/line-item.d.ts:20 ___ @@ -32,7 +32,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:26 +medusa/dist/models/line-item.d.ts:30 ___ @@ -42,7 +42,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:44 +medusa/dist/models/line-item.d.ts:49 ___ @@ -52,7 +52,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:11 +medusa/dist/models/line-item.d.ts:12 ___ @@ -62,7 +62,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:10 +medusa/dist/models/line-item.d.ts:11 ___ @@ -72,7 +72,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:17 +medusa/dist/models/line-item.d.ts:18 ___ @@ -82,7 +82,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:16 +medusa/dist/models/line-item.d.ts:17 ___ @@ -106,7 +106,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:21 +medusa/dist/models/line-item.d.ts:25 ___ @@ -116,7 +116,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:42 +medusa/dist/models/line-item.d.ts:47 ___ @@ -126,7 +126,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:32 +medusa/dist/models/line-item.d.ts:36 ___ @@ -136,7 +136,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:43 +medusa/dist/models/line-item.d.ts:48 ___ @@ -146,7 +146,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:27 +medusa/dist/models/line-item.d.ts:31 ___ @@ -164,13 +164,23 @@ medusa/dist/interfaces/models/base-entity.d.ts:5 ___ +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/models/line-item.d.ts:40 + +___ + ### is\_giftcard • **is\_giftcard**: `boolean` #### Defined in -medusa/dist/models/line-item.d.ts:24 +medusa/dist/models/line-item.d.ts:28 ___ @@ -180,7 +190,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:23 +medusa/dist/models/line-item.d.ts:27 ___ @@ -190,7 +200,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:35 +medusa/dist/models/line-item.d.ts:39 ___ @@ -200,17 +210,47 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:13 +medusa/dist/models/line-item.d.ts:14 + +___ + +### order\_edit + +• `Optional` **order\_edit**: ``null`` \| [`OrderEdit`](internal.OrderEdit.md) + +#### Defined in + +medusa/dist/models/line-item.d.ts:23 + +___ + +### order\_edit\_id + +• `Optional` **order\_edit\_id**: ``null`` \| `string` + +#### Defined in + +medusa/dist/models/line-item.d.ts:22 ___ ### order\_id -• **order\_id**: `string` +• **order\_id**: ``null`` \| `string` #### Defined in -medusa/dist/models/line-item.d.ts:12 +medusa/dist/models/line-item.d.ts:13 + +___ + +### original\_item\_id + +• `Optional` **original\_item\_id**: ``null`` \| `string` + +#### Defined in + +medusa/dist/models/line-item.d.ts:21 ___ @@ -220,7 +260,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:41 +medusa/dist/models/line-item.d.ts:46 ___ @@ -230,7 +270,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:40 +medusa/dist/models/line-item.d.ts:45 ___ @@ -240,7 +280,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:31 +medusa/dist/models/line-item.d.ts:35 ___ @@ -250,7 +290,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:36 +medusa/dist/models/line-item.d.ts:41 ___ @@ -260,7 +300,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:33 +medusa/dist/models/line-item.d.ts:37 ___ @@ -270,7 +310,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:34 +medusa/dist/models/line-item.d.ts:38 ___ @@ -280,7 +320,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:25 +medusa/dist/models/line-item.d.ts:29 ___ @@ -290,7 +330,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:37 +medusa/dist/models/line-item.d.ts:42 ___ @@ -300,7 +340,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:15 +medusa/dist/models/line-item.d.ts:16 ___ @@ -310,7 +350,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:14 +medusa/dist/models/line-item.d.ts:15 ___ @@ -320,7 +360,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:18 +medusa/dist/models/line-item.d.ts:19 ___ @@ -330,7 +370,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:38 +medusa/dist/models/line-item.d.ts:43 ___ @@ -340,7 +380,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:22 +medusa/dist/models/line-item.d.ts:26 ___ @@ -350,7 +390,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:20 +medusa/dist/models/line-item.d.ts:24 ___ @@ -360,7 +400,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:39 +medusa/dist/models/line-item.d.ts:44 ___ @@ -370,7 +410,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:28 +medusa/dist/models/line-item.d.ts:32 ___ @@ -394,7 +434,7 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:30 +medusa/dist/models/line-item.d.ts:34 ___ @@ -404,4 +444,4 @@ ___ #### Defined in -medusa/dist/models/line-item.d.ts:29 +medusa/dist/models/line-item.d.ts:33 diff --git a/docs/content/references/js-client/classes/internal.MoneyAmount.md b/docs/content/references/js-client/classes/internal.MoneyAmount.md index 82eaf5b4d7..ee3ed62f69 100644 --- a/docs/content/references/js-client/classes/internal.MoneyAmount.md +++ b/docs/content/references/js-client/classes/internal.MoneyAmount.md @@ -52,7 +52,7 @@ ___ ### currency -• **currency**: [`Currency`](internal.Currency.md) +• `Optional` **currency**: [`Currency`](internal.Currency.md) #### Defined in @@ -140,7 +140,7 @@ ___ ### region -• **region**: [`Region`](internal.Region.md) +• `Optional` **region**: [`Region`](internal.Region.md) #### Defined in diff --git a/docs/content/references/js-client/classes/internal.Order.md b/docs/content/references/js-client/classes/internal.Order.md index dda9f663a0..69242b99ad 100644 --- a/docs/content/references/js-client/classes/internal.Order.md +++ b/docs/content/references/js-client/classes/internal.Order.md @@ -22,7 +22,7 @@ Base abstract entity for all entities #### Defined in -medusa/dist/models/order.d.ts:97 +medusa/dist/models/order.d.ts:99 ___ @@ -32,7 +32,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:59 +medusa/dist/models/order.d.ts:60 ___ @@ -42,7 +42,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:58 +medusa/dist/models/order.d.ts:59 ___ @@ -52,7 +52,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:80 +medusa/dist/models/order.d.ts:82 ___ @@ -62,7 +62,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:54 +medusa/dist/models/order.d.ts:55 ___ @@ -72,7 +72,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:53 +medusa/dist/models/order.d.ts:54 ___ @@ -82,7 +82,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:73 +medusa/dist/models/order.d.ts:74 ___ @@ -106,7 +106,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:65 +medusa/dist/models/order.d.ts:66 ___ @@ -116,7 +116,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:64 +medusa/dist/models/order.d.ts:65 ___ @@ -126,7 +126,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:56 +medusa/dist/models/order.d.ts:57 ___ @@ -136,7 +136,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:55 +medusa/dist/models/order.d.ts:56 ___ @@ -146,7 +146,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:88 +medusa/dist/models/order.d.ts:90 ___ @@ -156,7 +156,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:67 +medusa/dist/models/order.d.ts:68 ___ @@ -166,7 +166,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:52 +medusa/dist/models/order.d.ts:53 ___ @@ -176,7 +176,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:77 +medusa/dist/models/order.d.ts:78 ___ @@ -186,7 +186,17 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:76 +medusa/dist/models/order.d.ts:77 + +___ + +### edits + +• **edits**: [`OrderEdit`](internal.OrderEdit.md)[] + +#### Defined in + +medusa/dist/models/order.d.ts:79 ___ @@ -196,7 +206,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:57 +medusa/dist/models/order.d.ts:58 ___ @@ -206,7 +216,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:84 +medusa/dist/models/order.d.ts:86 ___ @@ -216,7 +226,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:50 +medusa/dist/models/order.d.ts:51 ___ @@ -226,7 +236,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:71 +medusa/dist/models/order.d.ts:72 ___ @@ -236,7 +246,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:96 +medusa/dist/models/order.d.ts:98 ___ @@ -246,7 +256,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:95 +medusa/dist/models/order.d.ts:97 ___ @@ -256,7 +266,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:79 +medusa/dist/models/order.d.ts:81 ___ @@ -266,7 +276,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:68 +medusa/dist/models/order.d.ts:69 ___ @@ -290,7 +300,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:83 +medusa/dist/models/order.d.ts:85 ___ @@ -300,7 +310,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:78 +medusa/dist/models/order.d.ts:80 ___ @@ -310,7 +320,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:81 +medusa/dist/models/order.d.ts:83 ___ @@ -320,7 +330,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:82 +medusa/dist/models/order.d.ts:84 ___ @@ -330,7 +340,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:48 +medusa/dist/models/order.d.ts:49 ___ @@ -340,7 +350,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:93 +medusa/dist/models/order.d.ts:95 ___ @@ -350,7 +360,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:51 +medusa/dist/models/order.d.ts:52 ___ @@ -360,7 +370,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:70 +medusa/dist/models/order.d.ts:71 ___ @@ -370,7 +380,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:94 +medusa/dist/models/order.d.ts:96 ___ @@ -380,7 +390,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:90 +medusa/dist/models/order.d.ts:92 ___ @@ -390,7 +400,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:74 +medusa/dist/models/order.d.ts:75 ___ @@ -400,7 +410,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:63 +medusa/dist/models/order.d.ts:64 ___ @@ -410,7 +420,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:62 +medusa/dist/models/order.d.ts:63 ___ @@ -420,7 +430,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:72 +medusa/dist/models/order.d.ts:73 ___ @@ -430,7 +440,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:86 +medusa/dist/models/order.d.ts:88 ___ @@ -440,7 +450,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:85 +medusa/dist/models/order.d.ts:87 ___ @@ -450,7 +460,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:61 +medusa/dist/models/order.d.ts:62 ___ @@ -460,7 +470,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:60 +medusa/dist/models/order.d.ts:61 ___ @@ -470,7 +480,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:69 +medusa/dist/models/order.d.ts:70 ___ @@ -480,7 +490,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:87 +medusa/dist/models/order.d.ts:89 ___ @@ -490,7 +500,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:49 +medusa/dist/models/order.d.ts:50 ___ @@ -500,7 +510,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:92 +medusa/dist/models/order.d.ts:94 ___ @@ -510,7 +520,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:75 +medusa/dist/models/order.d.ts:76 ___ @@ -520,7 +530,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:66 +medusa/dist/models/order.d.ts:67 ___ @@ -530,7 +540,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:89 +medusa/dist/models/order.d.ts:91 ___ @@ -540,7 +550,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:91 +medusa/dist/models/order.d.ts:93 ___ diff --git a/docs/content/references/js-client/classes/internal.OrderEdit.md b/docs/content/references/js-client/classes/internal.OrderEdit.md new file mode 100644 index 0000000000..66a5cd41d5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.OrderEdit.md @@ -0,0 +1,321 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OrderEdit + +[internal](../modules/internal.md).OrderEdit + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`OrderEdit`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:37 + +___ + +### canceled\_at + +• `Optional` **canceled\_at**: `Date` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:26 + +___ + +### canceled\_by + +• `Optional` **canceled\_by**: `string` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:25 + +___ + +### changes + +• **changes**: [`OrderItemChange`](internal.OrderItemChange.md)[] + +#### Defined in + +medusa/dist/models/order-edit.d.ts:15 + +___ + +### confirmed\_at + +• `Optional` **confirmed\_at**: `Date` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:21 + +___ + +### confirmed\_by + +• `Optional` **confirmed\_by**: `string` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:20 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### created\_by + +• **created\_by**: `string` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:17 + +___ + +### declined\_at + +• `Optional` **declined\_at**: `Date` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:24 + +___ + +### declined\_by + +• `Optional` **declined\_by**: `string` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:22 + +___ + +### declined\_reason + +• `Optional` **declined\_reason**: `string` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:23 + +___ + +### difference\_due + +• **difference\_due**: `number` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:35 + +___ + +### discount\_total + +• **discount\_total**: `number` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:29 + +___ + +### gift\_card\_tax\_total + +• **gift\_card\_tax\_total**: `number` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:34 + +___ + +### gift\_card\_total + +• **gift\_card\_total**: `number` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:33 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### internal\_note + +• `Optional` **internal\_note**: `string` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:16 + +___ + +### items + +• **items**: [`LineItem`](internal.LineItem.md)[] + +#### Defined in + +medusa/dist/models/order-edit.d.ts:27 + +___ + +### order + +• **order**: [`Order`](internal.Order.md) + +#### Defined in + +medusa/dist/models/order-edit.d.ts:14 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:13 + +___ + +### requested\_at + +• `Optional` **requested\_at**: `Date` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:19 + +___ + +### requested\_by + +• `Optional` **requested\_by**: `string` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:18 + +___ + +### shipping\_total + +• **shipping\_total**: `number` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:28 + +___ + +### status + +• **status**: [`OrderEditStatus`](../enums/internal.OrderEditStatus.md) + +#### Defined in + +medusa/dist/models/order-edit.d.ts:36 + +___ + +### subtotal + +• **subtotal**: `number` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:32 + +___ + +### tax\_total + +• **tax\_total**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:30 + +___ + +### total + +• **total**: `number` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:31 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:7 + +## Methods + +### loadStatus + +▸ **loadStatus**(): `void` + +#### Returns + +`void` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:38 diff --git a/docs/content/references/js-client/classes/internal.OrderItemChange.md b/docs/content/references/js-client/classes/internal.OrderItemChange.md new file mode 100644 index 0000000000..56f01702da --- /dev/null +++ b/docs/content/references/js-client/classes/internal.OrderItemChange.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OrderItemChange + +[internal](../modules/internal.md).OrderItemChange + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`OrderItemChange`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:17 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### line\_item + +• `Optional` **line\_item**: [`LineItem`](internal.LineItem.md) + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:16 + +___ + +### line\_item\_id + +• `Optional` **line\_item\_id**: `string` + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:15 + +___ + +### order\_edit + +• **order\_edit**: [`OrderEdit`](internal.OrderEdit.md) + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:12 + +___ + +### order\_edit\_id + +• **order\_edit\_id**: `string` + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:11 + +___ + +### original\_line\_item + +• `Optional` **original\_line\_item**: [`LineItem`](internal.LineItem.md) + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:14 + +___ + +### original\_line\_item\_id + +• `Optional` **original\_line\_item\_id**: `string` + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:13 + +___ + +### type + +• **type**: [`OrderEditItemChangeType`](../enums/internal.OrderEditItemChangeType.md) + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:10 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.PriceList.md b/docs/content/references/js-client/classes/internal.PriceList.md index 32330b63fd..f08dc0d3dd 100644 --- a/docs/content/references/js-client/classes/internal.PriceList.md +++ b/docs/content/references/js-client/classes/internal.PriceList.md @@ -22,7 +22,7 @@ Base abstract entity for all entities #### Defined in -medusa/dist/models/price-list.d.ts:14 +medusa/dist/models/price-list.d.ts:15 ___ @@ -98,6 +98,16 @@ medusa/dist/interfaces/models/base-entity.d.ts:5 ___ +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/models/price-list.d.ts:14 + +___ + ### name • **name**: `string` diff --git a/docs/content/references/js-client/classes/internal.Region.md b/docs/content/references/js-client/classes/internal.Region.md index a8e0693ca8..698facbc9c 100644 --- a/docs/content/references/js-client/classes/internal.Region.md +++ b/docs/content/references/js-client/classes/internal.Region.md @@ -32,7 +32,7 @@ ___ #### Defined in -medusa/dist/models/region.d.ts:23 +medusa/dist/models/region.d.ts:24 ___ @@ -128,6 +128,16 @@ medusa/dist/interfaces/models/base-entity.d.ts:5 ___ +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/models/region.d.ts:23 + +___ + ### metadata • **metadata**: `Record`<`string`, `unknown`\> diff --git a/docs/content/references/js-client/classes/internal.ShippingMethod.md b/docs/content/references/js-client/classes/internal.ShippingMethod.md index 41e1710233..c0194b37e7 100644 --- a/docs/content/references/js-client/classes/internal.ShippingMethod.md +++ b/docs/content/references/js-client/classes/internal.ShippingMethod.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/shipping-method.d.ts:25 +medusa/dist/models/shipping-method.d.ts:26 ___ @@ -78,6 +78,16 @@ medusa/dist/models/shipping-method.d.ts:9 ___ +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/models/shipping-method.d.ts:25 + +___ + ### order • **order**: [`Order`](internal.Order.md) diff --git a/docs/content/references/js-client/classes/internal.ShippingOption.md b/docs/content/references/js-client/classes/internal.ShippingOption.md index e0f23b6004..e2635bd0fc 100644 --- a/docs/content/references/js-client/classes/internal.ShippingOption.md +++ b/docs/content/references/js-client/classes/internal.ShippingOption.md @@ -42,7 +42,7 @@ ___ #### Defined in -medusa/dist/models/shipping-option.d.ts:25 +medusa/dist/models/shipping-option.d.ts:26 ___ @@ -98,6 +98,16 @@ medusa/dist/interfaces/models/base-entity.d.ts:5 ___ +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +medusa/dist/models/shipping-option.d.ts:25 + +___ + ### is\_return • **is\_return**: `boolean` diff --git a/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md b/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md index 9bc391391b..71fe38d077 100644 --- a/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md +++ b/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md @@ -44,6 +44,8 @@ Base abstract entity for all entities ↳↳ [`ClaimItem`](internal.ClaimItem.md) + ↳↳ [`OrderItemChange`](internal.OrderItemChange.md) + ↳↳ [`ProductVariant`](internal.ProductVariant.md) ↳↳ [`MoneyAmount`](internal.MoneyAmount.md) @@ -76,9 +78,9 @@ Base abstract entity for all entities ↳↳ [`BatchJob`](internal-2.BatchJob.md) - ↳↳ [`Invite`](internal-9.Invite.md) + ↳↳ [`Invite`](internal-10.Invite.md) - ↳↳ [`Note`](internal-10.Note.md) + ↳↳ [`Note`](internal-11.Note.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md index 28589fbe04..b56efd71fc 100644 --- a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md @@ -24,7 +24,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/types/common.d.ts:95 +medusa/dist/types/common.d.ts:96 ___ @@ -38,7 +38,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:96 +medusa/dist/types/common.d.ts:97 ___ @@ -52,7 +52,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:97 +medusa/dist/types/common.d.ts:98 ___ @@ -66,7 +66,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:94 +medusa/dist/types/common.d.ts:95 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:98 +medusa/dist/types/common.d.ts:99 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:90 +medusa/dist/types/common.d.ts:91 ___ @@ -108,7 +108,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:91 +medusa/dist/types/common.d.ts:92 ___ @@ -122,7 +122,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:93 +medusa/dist/types/common.d.ts:94 ___ @@ -136,7 +136,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:92 +medusa/dist/types/common.d.ts:93 ___ @@ -150,7 +150,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:100 +medusa/dist/types/common.d.ts:101 ___ @@ -164,4 +164,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:99 +medusa/dist/types/common.d.ts:100 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md index 29ad5a5d54..559ec619d8 100644 --- a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md @@ -14,4 +14,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/api/routes/store/customers/create-address.d.ts:34 +medusa/dist/api/routes/store/customers/create-address.d.ts:89 diff --git a/docs/content/references/js-client/classes/internal.Swap.md b/docs/content/references/js-client/classes/internal.Swap.md index f285191e33..f7f9e40d31 100644 --- a/docs/content/references/js-client/classes/internal.Swap.md +++ b/docs/content/references/js-client/classes/internal.Swap.md @@ -22,7 +22,7 @@ Base abstract entity for all entities #### Defined in -medusa/dist/models/swap.d.ts:33 +medusa/dist/models/swap.d.ts:34 ___ @@ -32,7 +32,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:46 +medusa/dist/models/swap.d.ts:47 ___ @@ -42,7 +42,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:49 +medusa/dist/models/swap.d.ts:50 ___ @@ -52,7 +52,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:44 +medusa/dist/models/swap.d.ts:45 ___ @@ -62,7 +62,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:42 +medusa/dist/models/swap.d.ts:43 ___ @@ -72,7 +72,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:41 +medusa/dist/models/swap.d.ts:42 ___ @@ -82,7 +82,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:43 +medusa/dist/models/swap.d.ts:44 ___ @@ -120,7 +120,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:37 +medusa/dist/models/swap.d.ts:38 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:29 +medusa/dist/models/swap.d.ts:30 ___ @@ -140,7 +140,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:35 +medusa/dist/models/swap.d.ts:36 ___ @@ -164,7 +164,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:47 +medusa/dist/models/swap.d.ts:48 ___ @@ -174,7 +174,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:48 +medusa/dist/models/swap.d.ts:49 ___ @@ -184,7 +184,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:45 +medusa/dist/models/swap.d.ts:46 ___ @@ -194,7 +194,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:32 +medusa/dist/models/swap.d.ts:33 ___ @@ -204,7 +204,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:31 +medusa/dist/models/swap.d.ts:32 ___ @@ -214,7 +214,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:36 +medusa/dist/models/swap.d.ts:37 ___ @@ -224,7 +224,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:30 +medusa/dist/models/swap.d.ts:31 ___ @@ -234,7 +234,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:34 +medusa/dist/models/swap.d.ts:35 ___ @@ -244,7 +244,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:39 +medusa/dist/models/swap.d.ts:40 ___ @@ -254,7 +254,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:38 +medusa/dist/models/swap.d.ts:39 ___ @@ -264,7 +264,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:40 +medusa/dist/models/swap.d.ts:41 ___ diff --git a/docs/content/references/js-client/enums/internal.FulfillmentStatus.md b/docs/content/references/js-client/enums/internal.FulfillmentStatus.md index f1dc2ce7d3..82297dab01 100644 --- a/docs/content/references/js-client/enums/internal.FulfillmentStatus.md +++ b/docs/content/references/js-client/enums/internal.FulfillmentStatus.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/order.d.ts:35 +medusa/dist/models/order.d.ts:36 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:30 +medusa/dist/models/order.d.ts:31 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:28 +medusa/dist/models/order.d.ts:29 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:29 +medusa/dist/models/order.d.ts:30 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:33 +medusa/dist/models/order.d.ts:34 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:31 +medusa/dist/models/order.d.ts:32 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:36 +medusa/dist/models/order.d.ts:37 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:34 +medusa/dist/models/order.d.ts:35 ___ @@ -94,4 +94,4 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:32 +medusa/dist/models/order.d.ts:33 diff --git a/docs/content/references/js-client/enums/internal.OrderEditItemChangeType.md b/docs/content/references/js-client/enums/internal.OrderEditItemChangeType.md new file mode 100644 index 0000000000..e59b935ac6 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.OrderEditItemChangeType.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: OrderEditItemChangeType + +[internal](../modules/internal.md).OrderEditItemChangeType + +## Enumeration Members + +### ITEM\_ADD + +• **ITEM\_ADD** = ``"item_add"`` + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:5 + +___ + +### ITEM\_REMOVE + +• **ITEM\_REMOVE** = ``"item_remove"`` + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:6 + +___ + +### ITEM\_UPDATE + +• **ITEM\_UPDATE** = ``"item_update"`` + +#### Defined in + +medusa/dist/models/order-item-change.d.ts:7 diff --git a/docs/content/references/js-client/enums/internal.OrderEditStatus.md b/docs/content/references/js-client/enums/internal.OrderEditStatus.md new file mode 100644 index 0000000000..29ae837016 --- /dev/null +++ b/docs/content/references/js-client/enums/internal.OrderEditStatus.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: OrderEditStatus + +[internal](../modules/internal.md).OrderEditStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:10 + +___ + +### CONFIRMED + +• **CONFIRMED** = ``"confirmed"`` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:6 + +___ + +### CREATED + +• **CREATED** = ``"created"`` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:9 + +___ + +### DECLINED + +• **DECLINED** = ``"declined"`` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:7 + +___ + +### REQUESTED + +• **REQUESTED** = ``"requested"`` + +#### Defined in + +medusa/dist/models/order-edit.d.ts:8 diff --git a/docs/content/references/js-client/enums/internal.OrderStatus.md b/docs/content/references/js-client/enums/internal.OrderStatus.md index 3522f4f647..2a7cfed4e0 100644 --- a/docs/content/references/js-client/enums/internal.OrderStatus.md +++ b/docs/content/references/js-client/enums/internal.OrderStatus.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/order.d.ts:23 +medusa/dist/models/order.d.ts:24 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:24 +medusa/dist/models/order.d.ts:25 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:22 +medusa/dist/models/order.d.ts:23 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:21 +medusa/dist/models/order.d.ts:22 ___ @@ -54,4 +54,4 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:25 +medusa/dist/models/order.d.ts:26 diff --git a/docs/content/references/js-client/enums/internal.PaymentStatus.md b/docs/content/references/js-client/enums/internal.PaymentStatus.md index f0529bb78e..3fbde93965 100644 --- a/docs/content/references/js-client/enums/internal.PaymentStatus.md +++ b/docs/content/references/js-client/enums/internal.PaymentStatus.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/order.d.ts:40 +medusa/dist/models/order.d.ts:41 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:44 +medusa/dist/models/order.d.ts:45 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:41 +medusa/dist/models/order.d.ts:42 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:39 +medusa/dist/models/order.d.ts:40 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:42 +medusa/dist/models/order.d.ts:43 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:43 +medusa/dist/models/order.d.ts:44 ___ @@ -74,4 +74,4 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:45 +medusa/dist/models/order.d.ts:46 diff --git a/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md b/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md index febdd04917..daf462612b 100644 --- a/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md +++ b/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/swap.d.ts:14 +medusa/dist/models/swap.d.ts:15 ___ @@ -38,13 +38,23 @@ medusa/dist/models/swap.d.ts:11 ___ +### PARTIALLY\_SHIPPED + +• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + +#### Defined in + +medusa/dist/models/swap.d.ts:14 + +___ + ### REQUIRES\_ACTION • **REQUIRES\_ACTION** = ``"requires_action"`` #### Defined in -medusa/dist/models/swap.d.ts:15 +medusa/dist/models/swap.d.ts:16 ___ diff --git a/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md b/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md index c6ae33d95f..2c0f8ba7ad 100644 --- a/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md +++ b/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/swap.d.ts:19 +medusa/dist/models/swap.d.ts:20 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:22 +medusa/dist/models/swap.d.ts:23 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:20 +medusa/dist/models/swap.d.ts:21 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:21 +medusa/dist/models/swap.d.ts:22 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:23 +medusa/dist/models/swap.d.ts:24 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:18 +medusa/dist/models/swap.d.ts:19 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:24 +medusa/dist/models/swap.d.ts:25 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:25 +medusa/dist/models/swap.d.ts:26 ___ @@ -94,4 +94,4 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:26 +medusa/dist/models/swap.d.ts:27 diff --git a/docs/content/references/js-client/index.md b/docs/content/references/js-client/index.md index b7b19e0745..a178432962 100644 --- a/docs/content/references/js-client/index.md +++ b/docs/content/references/js-client/index.md @@ -46,6 +46,9 @@ - [internal](modules/internal-41.md) - [internal](modules/internal-42.md) - [internal](modules/internal-43.md) +- [internal](modules/internal-44.md) +- [internal](modules/internal-45.md) +- [internal](modules/internal-46.md) ## Classes @@ -54,6 +57,7 @@ - [AdminAuthResource](classes/AdminAuthResource.md) - [AdminBatchJobsResource](classes/AdminBatchJobsResource.md) - [AdminCollectionsResource](classes/AdminCollectionsResource.md) +- [AdminCurrenciesResource](classes/AdminCurrenciesResource.md) - [AdminCustomerGroupsResource](classes/AdminCustomerGroupsResource.md) - [AdminCustomersResource](classes/AdminCustomersResource.md) - [AdminDiscountsResource](classes/AdminDiscountsResource.md) @@ -62,6 +66,7 @@ - [AdminInvitesResource](classes/AdminInvitesResource.md) - [AdminNotesResource](classes/AdminNotesResource.md) - [AdminNotificationsResource](classes/AdminNotificationsResource.md) +- [AdminOrderEditsResource](classes/AdminOrderEditsResource.md) - [AdminOrdersResource](classes/AdminOrdersResource.md) - [AdminPriceListResource](classes/AdminPriceListResource.md) - [AdminProductTagsResource](classes/AdminProductTagsResource.md) @@ -85,6 +90,7 @@ - [CustomerResource](classes/CustomerResource.md) - [GiftCardsResource](classes/GiftCardsResource.md) - [LineItemsResource](classes/LineItemsResource.md) +- [OrderEditsResource](classes/OrderEditsResource.md) - [OrdersResource](classes/OrdersResource.md) - [PaymentMethodsResource](classes/PaymentMethodsResource.md) - [ProductVariantsResource](classes/ProductVariantsResource.md) diff --git a/docs/content/references/js-client/interfaces/internal.Config.md b/docs/content/references/js-client/interfaces/internal.Config.md index e1fb1dc9b3..c594cd76fc 100644 --- a/docs/content/references/js-client/interfaces/internal.Config.md +++ b/docs/content/references/js-client/interfaces/internal.Config.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -[medusa-js/src/request.ts:14](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L14) +[medusa-js/src/request.ts:14](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L14) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:12](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L12) +[medusa-js/src/request.ts:12](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L12) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[medusa-js/src/request.ts:13](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L13) +[medusa-js/src/request.ts:13](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L13) diff --git a/docs/content/references/js-client/interfaces/internal.HTTPResponse.md b/docs/content/references/js-client/interfaces/internal.HTTPResponse.md index 34c0177f1a..6e195cbc1e 100644 --- a/docs/content/references/js-client/interfaces/internal.HTTPResponse.md +++ b/docs/content/references/js-client/interfaces/internal.HTTPResponse.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -[medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L13) +[medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L13) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L10) +[medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L10) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L14) +[medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L14) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L8) +[medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L8) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L9) +[medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L9) diff --git a/docs/content/references/js-client/interfaces/internal.RequestOptions.md b/docs/content/references/js-client/interfaces/internal.RequestOptions.md index 510b92646f..fdf4b73f9c 100644 --- a/docs/content/references/js-client/interfaces/internal.RequestOptions.md +++ b/docs/content/references/js-client/interfaces/internal.RequestOptions.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -[medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L18) +[medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L18) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L17) +[medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L17) diff --git a/docs/content/references/js-client/modules/internal-10.md b/docs/content/references/js-client/modules/internal-10.md index adb9caec2c..2ac1bdc70d 100644 --- a/docs/content/references/js-client/modules/internal-10.md +++ b/docs/content/references/js-client/modules/internal-10.md @@ -2,33 +2,43 @@ ## Classes -- [AdminGetNotesParams](../classes/internal-10.AdminGetNotesParams.md) -- [AdminPostNotesNoteReq](../classes/internal-10.AdminPostNotesNoteReq.md) -- [AdminPostNotesReq](../classes/internal-10.AdminPostNotesReq.md) -- [Note](../classes/internal-10.Note.md) +- [AdminPostInvitesInviteAcceptReq](../classes/internal-10.AdminPostInvitesInviteAcceptReq.md) +- [AdminPostInvitesInviteAcceptUserReq](../classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md) +- [AdminPostInvitesReq](../classes/internal-10.AdminPostInvitesReq.md) +- [Invite](../classes/internal-10.Invite.md) ## Type Aliases -### AdminNotesListRes +### AdminListInvitesRes -Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-10.Note.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/notes/index.d.ts:10 - -___ - -### AdminNotesRes - -Ƭ **AdminNotesRes**: `Object` +Ƭ **AdminListInvitesRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `note` | [`Note`](../classes/internal-10.Note.md) | +| `invites` | [`Invite`](../classes/internal-10.Invite.md)[] | #### Defined in -medusa/dist/api/routes/admin/notes/index.d.ts:6 +medusa/dist/api/routes/admin/invites/index.d.ts:8 + +___ + +### AdminPostInvitesPayload + +Ƭ **AdminPostInvitesPayload**: `Omit`<[`AdminPostInvitesReq`](../classes/internal-10.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-10.md#inviteuserrolesenum) } + +#### Defined in + +[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L47) + +___ + +### InviteUserRolesEnum + +Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` + +#### Defined in + +[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L45) diff --git a/docs/content/references/js-client/modules/internal-11.md b/docs/content/references/js-client/modules/internal-11.md index 5e1e85393a..b6a49bb92d 100644 --- a/docs/content/references/js-client/modules/internal-11.md +++ b/docs/content/references/js-client/modules/internal-11.md @@ -2,39 +2,33 @@ ## Classes -- [AdminGetNotificationsParams](../classes/internal-11.AdminGetNotificationsParams.md) -- [AdminPostNotificationsNotificationResendReq](../classes/internal-11.AdminPostNotificationsNotificationResendReq.md) -- [Notification](../classes/internal-11.Notification.md) -- [NotificationProvider](../classes/internal-11.NotificationProvider.md) +- [AdminGetNotesParams](../classes/internal-11.AdminGetNotesParams.md) +- [AdminPostNotesNoteReq](../classes/internal-11.AdminPostNotesNoteReq.md) +- [AdminPostNotesReq](../classes/internal-11.AdminPostNotesReq.md) +- [Note](../classes/internal-11.Note.md) ## Type Aliases -### AdminNotificationsListRes +### AdminNotesListRes -Ƭ **AdminNotificationsListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `notifications` | [`Notification`](../classes/internal-11.Notification.md)[] | +Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-11.Note.md)[] } #### Defined in -medusa/dist/api/routes/admin/notifications/index.d.ts:8 +medusa/dist/api/routes/admin/notes/index.d.ts:10 ___ -### AdminNotificationsRes +### AdminNotesRes -Ƭ **AdminNotificationsRes**: `Object` +Ƭ **AdminNotesRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `notification` | [`Notification`](../classes/internal-11.Notification.md) | +| `note` | [`Note`](../classes/internal-11.Note.md) | #### Defined in -medusa/dist/api/routes/admin/notifications/index.d.ts:11 +medusa/dist/api/routes/admin/notes/index.d.ts:6 diff --git a/docs/content/references/js-client/modules/internal-12.md b/docs/content/references/js-client/modules/internal-12.md index 63606088d1..5ddb222efc 100644 --- a/docs/content/references/js-client/modules/internal-12.md +++ b/docs/content/references/js-client/modules/internal-12.md @@ -2,61 +2,39 @@ ## Classes -- [AdditionalItem](../classes/internal-12.AdditionalItem.md) -- [AdditionalItem](../classes/internal-12.AdditionalItem-1.md) -- [AdminGetOrdersParams](../classes/internal-12.AdminGetOrdersParams.md) -- [AdminListOrdersSelector](../classes/internal-12.AdminListOrdersSelector.md) -- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) -- [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md) -- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) -- [AdminPostOrdersOrderClaimsReq](../classes/internal-12.AdminPostOrdersOrderClaimsReq.md) -- [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md) -- [AdminPostOrdersOrderRefundsReq](../classes/internal-12.AdminPostOrdersOrderRefundsReq.md) -- [AdminPostOrdersOrderReq](../classes/internal-12.AdminPostOrdersOrderReq.md) -- [AdminPostOrdersOrderReturnsReq](../classes/internal-12.AdminPostOrdersOrderReturnsReq.md) -- [AdminPostOrdersOrderShipmentReq](../classes/internal-12.AdminPostOrdersOrderShipmentReq.md) -- [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md) -- [AdminPostOrdersOrderSwapsReq](../classes/internal-12.AdminPostOrdersOrderSwapsReq.md) -- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) -- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) -- [CustomShippingOption](../classes/internal-12.CustomShippingOption.md) -- [Image](../classes/internal-12.Image.md) -- [Item](../classes/internal-12.Item.md) -- [Item](../classes/internal-12.Item-1.md) -- [Item](../classes/internal-12.Item-2.md) -- [OrdersReturnItem](../classes/internal-12.OrdersReturnItem.md) -- [PaymentMethod](../classes/internal-12.PaymentMethod.md) -- [ReturnItem](../classes/internal-12.ReturnItem.md) -- [ReturnShipping](../classes/internal-12.ReturnShipping.md) -- [ReturnShipping](../classes/internal-12.ReturnShipping-1.md) -- [ReturnShipping](../classes/internal-12.ReturnShipping-2.md) -- [ShippingMethod](../classes/internal-12.ShippingMethod.md) -- [ShippingMethod](../classes/internal-12.ShippingMethod-1.md) -- [ShippingMethod](../classes/internal-12.ShippingMethod-2.md) -- [Tag](../classes/internal-12.Tag.md) +- [AdminGetNotificationsParams](../classes/internal-12.AdminGetNotificationsParams.md) +- [AdminPostNotificationsNotificationResendReq](../classes/internal-12.AdminPostNotificationsNotificationResendReq.md) +- [Notification](../classes/internal-12.Notification.md) +- [NotificationProvider](../classes/internal-12.NotificationProvider.md) ## Type Aliases -### AdminOrdersListRes +### AdminNotificationsListRes -Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/orders/index.d.ts:11 - -___ - -### AdminOrdersRes - -Ƭ **AdminOrdersRes**: `Object` +Ƭ **AdminNotificationsListRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | +| `notifications` | [`Notification`](../classes/internal-12.Notification.md)[] | #### Defined in -medusa/dist/api/routes/admin/orders/index.d.ts:7 +medusa/dist/api/routes/admin/notifications/index.d.ts:8 + +___ + +### AdminNotificationsRes + +Ƭ **AdminNotificationsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `notification` | [`Notification`](../classes/internal-12.Notification.md) | + +#### Defined in + +medusa/dist/api/routes/admin/notifications/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-13.md b/docs/content/references/js-client/modules/internal-13.md index 042057f243..bf4ffdccf5 100644 --- a/docs/content/references/js-client/modules/internal-13.md +++ b/docs/content/references/js-client/modules/internal-13.md @@ -1,73 +1,42 @@ # Namespace: internal -## Namespaces - -- ["/Users/shahednasser/medusa/packages/medusa/dist/types/global"](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) - ## Classes -- [AdminDeletePriceListPricesPricesReq](../classes/internal-13.AdminDeletePriceListPricesPricesReq.md) -- [AdminGetPriceListPaginationParams](../classes/internal-13.AdminGetPriceListPaginationParams.md) -- [AdminGetPriceListsPriceListProductsParams](../classes/internal-13.AdminGetPriceListsPriceListProductsParams.md) -- [AdminPostPriceListPricesPricesReq](../classes/internal-13.AdminPostPriceListPricesPricesReq.md) -- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md) -- [AdminPostPriceListsPriceListReq](../classes/internal-13.AdminPostPriceListsPriceListReq.md) -- [AdminPriceListPricesCreateReq](../classes/internal-13.AdminPriceListPricesCreateReq.md) -- [AdminPriceListPricesUpdateReq](../classes/internal-13.AdminPriceListPricesUpdateReq.md) -- [CustomerGroup](../classes/internal-13.CustomerGroup.md) -- [CustomerGroup](../classes/internal-13.CustomerGroup-1.md) -- [FilterablePriceListProps](../classes/internal-13.FilterablePriceListProps.md) +- [AdminPostOrderEditsEditLineItemsLineItemReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md) +- [AdminPostOrderEditsEditLineItemsReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md) +- [AdminPostOrderEditsOrderEditReq](../classes/internal-13.AdminPostOrderEditsOrderEditReq.md) +- [AdminPostOrderEditsReq](../classes/internal-13.AdminPostOrderEditsReq.md) ## Type Aliases -### AdminPriceListDeleteBatchRes +### AdminOrderEditItemChangeDeleteRes -Ƭ **AdminPriceListDeleteBatchRes**: `Object` +Ƭ **AdminOrderEditItemChangeDeleteRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | -| `ids` | `string`[] | -| `object` | `string` | +| `id` | `string` | +| `object` | ``"item_change"`` | #### Defined in -medusa/dist/api/routes/admin/price-lists/index.d.ts:12 +medusa/dist/api/routes/admin/order-edits/index.d.ts:9 ___ -### AdminPriceListRes +### AdminOrderEditsRes -Ƭ **AdminPriceListRes**: `Object` +Ƭ **AdminOrderEditsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `price_list` | [`PriceList`](../classes/internal.PriceList.md) | +| `order_edit` | [`OrderEdit`](../classes/internal.OrderEdit.md) | #### Defined in -medusa/dist/api/routes/admin/price-lists/index.d.ts:9 - -___ - -### AdminPriceListsListRes - -Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/index.d.ts:20 - -## Variables - -### AdminGetPriceListsPriceListProductsParams\_base - -• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:143 +medusa/dist/api/routes/admin/order-edits/index.d.ts:5 diff --git a/docs/content/references/js-client/modules/internal-14.md b/docs/content/references/js-client/modules/internal-14.md index 6d448a0ce2..723baa2d82 100644 --- a/docs/content/references/js-client/modules/internal-14.md +++ b/docs/content/references/js-client/modules/internal-14.md @@ -2,15 +2,61 @@ ## Classes -- [AdminGetProductTagsPaginationParams](../classes/internal-14.AdminGetProductTagsPaginationParams.md) -- [AdminGetProductTagsParams](../classes/internal-14.AdminGetProductTagsParams.md) +- [AdditionalItem](../classes/internal-14.AdditionalItem.md) +- [AdditionalItem](../classes/internal-14.AdditionalItem-1.md) +- [AdminGetOrdersParams](../classes/internal-14.AdminGetOrdersParams.md) +- [AdminListOrdersSelector](../classes/internal-14.AdminListOrdersSelector.md) +- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) +- [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md) +- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) +- [AdminPostOrdersOrderClaimsReq](../classes/internal-14.AdminPostOrdersOrderClaimsReq.md) +- [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md) +- [AdminPostOrdersOrderRefundsReq](../classes/internal-14.AdminPostOrdersOrderRefundsReq.md) +- [AdminPostOrdersOrderReq](../classes/internal-14.AdminPostOrdersOrderReq.md) +- [AdminPostOrdersOrderReturnsReq](../classes/internal-14.AdminPostOrdersOrderReturnsReq.md) +- [AdminPostOrdersOrderShipmentReq](../classes/internal-14.AdminPostOrdersOrderShipmentReq.md) +- [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md) +- [AdminPostOrdersOrderSwapsReq](../classes/internal-14.AdminPostOrdersOrderSwapsReq.md) +- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) +- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) +- [CustomShippingOption](../classes/internal-14.CustomShippingOption.md) +- [Image](../classes/internal-14.Image.md) +- [Item](../classes/internal-14.Item.md) +- [Item](../classes/internal-14.Item-1.md) +- [Item](../classes/internal-14.Item-2.md) +- [OrdersReturnItem](../classes/internal-14.OrdersReturnItem.md) +- [PaymentMethod](../classes/internal-14.PaymentMethod.md) +- [ReturnItem](../classes/internal-14.ReturnItem.md) +- [ReturnShipping](../classes/internal-14.ReturnShipping.md) +- [ReturnShipping](../classes/internal-14.ReturnShipping-1.md) +- [ReturnShipping](../classes/internal-14.ReturnShipping-2.md) +- [ShippingMethod](../classes/internal-14.ShippingMethod.md) +- [ShippingMethod](../classes/internal-14.ShippingMethod-1.md) +- [ShippingMethod](../classes/internal-14.ShippingMethod-2.md) +- [Tag](../classes/internal-14.Tag.md) ## Type Aliases -### AdminProductTagsListRes +### AdminOrdersListRes -Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] } +Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } #### Defined in -medusa/dist/api/routes/admin/product-tags/index.d.ts:9 +medusa/dist/api/routes/admin/orders/index.d.ts:11 + +___ + +### AdminOrdersRes + +Ƭ **AdminOrdersRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal.Order.md) | + +#### Defined in + +medusa/dist/api/routes/admin/orders/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md b/docs/content/references/js-client/modules/internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md similarity index 94% rename from docs/content/references/js-client/modules/internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md rename to docs/content/references/js-client/modules/internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md index 8a08e48ce4..1b2cb3a266 100644 --- a/docs/content/references/js-client/modules/internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md +++ b/docs/content/references/js-client/modules/internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md @@ -1,6 +1,6 @@ # Namespace: "/Users/shahednasser/medusa/packages/medusa/dist/types/global" -[internal](internal-13.md)."/Users/shahednasser/medusa/packages/medusa/dist/types/global" +[internal](internal-15.md)."/Users/shahednasser/medusa/packages/medusa/dist/types/global" ## Type Aliases @@ -76,7 +76,7 @@ ___ ### MedusaContainer -Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md#medusacontainer) } +Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md#medusacontainer) } #### Defined in diff --git a/docs/content/references/js-client/modules/internal-15.md b/docs/content/references/js-client/modules/internal-15.md index 0b45f572aa..a79d745e53 100644 --- a/docs/content/references/js-client/modules/internal-15.md +++ b/docs/content/references/js-client/modules/internal-15.md @@ -1,16 +1,73 @@ # Namespace: internal +## Namespaces + +- ["/Users/shahednasser/medusa/packages/medusa/dist/types/global"](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) + ## Classes -- [AdminGetProductTypesPaginationParams](../classes/internal-15.AdminGetProductTypesPaginationParams.md) -- [AdminGetProductTypesParams](../classes/internal-15.AdminGetProductTypesParams.md) +- [AdminDeletePriceListPricesPricesReq](../classes/internal-15.AdminDeletePriceListPricesPricesReq.md) +- [AdminGetPriceListPaginationParams](../classes/internal-15.AdminGetPriceListPaginationParams.md) +- [AdminGetPriceListsPriceListProductsParams](../classes/internal-15.AdminGetPriceListsPriceListProductsParams.md) +- [AdminPostPriceListPricesPricesReq](../classes/internal-15.AdminPostPriceListPricesPricesReq.md) +- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md) +- [AdminPostPriceListsPriceListReq](../classes/internal-15.AdminPostPriceListsPriceListReq.md) +- [AdminPriceListPricesCreateReq](../classes/internal-15.AdminPriceListPricesCreateReq.md) +- [AdminPriceListPricesUpdateReq](../classes/internal-15.AdminPriceListPricesUpdateReq.md) +- [CustomerGroup](../classes/internal-15.CustomerGroup.md) +- [CustomerGroup](../classes/internal-15.CustomerGroup-1.md) +- [FilterablePriceListProps](../classes/internal-15.FilterablePriceListProps.md) ## Type Aliases -### AdminProductTypesListRes +### AdminPriceListDeleteBatchRes -Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] } +Ƭ **AdminPriceListDeleteBatchRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `ids` | `string`[] | +| `object` | `string` | #### Defined in -medusa/dist/api/routes/admin/product-types/index.d.ts:9 +medusa/dist/api/routes/admin/price-lists/index.d.ts:13 + +___ + +### AdminPriceListRes + +Ƭ **AdminPriceListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `price_list` | [`PriceList`](../classes/internal.PriceList.md) | + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/index.d.ts:10 + +___ + +### AdminPriceListsListRes + +Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/index.d.ts:21 + +## Variables + +### AdminGetPriceListsPriceListProductsParams\_base + +• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:174 diff --git a/docs/content/references/js-client/modules/internal-16.md b/docs/content/references/js-client/modules/internal-16.md index bc4c8b87fc..114e20bfbe 100644 --- a/docs/content/references/js-client/modules/internal-16.md +++ b/docs/content/references/js-client/modules/internal-16.md @@ -2,210 +2,15 @@ ## Classes -- [AdminGetProductsParams](../classes/internal-16.AdminGetProductsParams.md) -- [AdminPostProductsProductMetadataReq](../classes/internal-16.AdminPostProductsProductMetadataReq.md) -- [AdminPostProductsProductOptionsOption](../classes/internal-16.AdminPostProductsProductOptionsOption.md) -- [AdminPostProductsProductOptionsReq](../classes/internal-16.AdminPostProductsProductOptionsReq.md) -- [AdminPostProductsProductReq](../classes/internal-16.AdminPostProductsProductReq.md) -- [AdminPostProductsProductVariantsReq](../classes/internal-16.AdminPostProductsProductVariantsReq.md) -- [AdminPostProductsProductVariantsVariantReq](../classes/internal-16.AdminPostProductsProductVariantsVariantReq.md) -- [AdminPostProductsReq](../classes/internal-16.AdminPostProductsReq.md) -- [FilterableProductProps](../classes/internal-16.FilterableProductProps.md) -- [ProductOptionReq](../classes/internal-16.ProductOptionReq.md) -- [ProductSalesChannelReq](../classes/internal-16.ProductSalesChannelReq.md) -- [ProductTagReq](../classes/internal-16.ProductTagReq.md) -- [ProductTypeReq](../classes/internal-16.ProductTypeReq.md) -- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq.md) -- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-1.md) -- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-2.md) -- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-3.md) -- [ProductVariantPricesCreateReq](../classes/internal-16.ProductVariantPricesCreateReq.md) -- [ProductVariantPricesUpdateReq](../classes/internal-16.ProductVariantPricesUpdateReq.md) -- [ProductVariantReq](../classes/internal-16.ProductVariantReq.md) -- [ProductVariantReq](../classes/internal-16.ProductVariantReq-1.md) +- [AdminGetProductTagsPaginationParams](../classes/internal-16.AdminGetProductTagsPaginationParams.md) +- [AdminGetProductTagsParams](../classes/internal-16.AdminGetProductTagsParams.md) ## Type Aliases -### AdminProductsDeleteOptionRes +### AdminProductTagsListRes -Ƭ **AdminProductsDeleteOptionRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `object` | ``"option"`` | -| `option_id` | `string` | -| `product` | [`Product`](../classes/internal.Product.md) | +Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] } #### Defined in -medusa/dist/api/routes/admin/products/index.d.ts:13 - -___ - -### AdminProductsDeleteRes - -Ƭ **AdminProductsDeleteRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `id` | `string` | -| `object` | ``"product"`` | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:25 - -___ - -### AdminProductsDeleteVariantRes - -Ƭ **AdminProductsDeleteVariantRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `object` | ``"product-variant"`` | -| `product` | [`Product`](../classes/internal.Product.md) | -| `variant_id` | `string` | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:19 - -___ - -### AdminProductsListRes - -Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-16.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] } - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:30 - -___ - -### AdminProductsListTagsRes - -Ƭ **AdminProductsListTagsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:36 - -___ - -### AdminProductsListTypesRes - -Ƭ **AdminProductsListTypesRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `types` | [`ProductType`](../classes/internal.ProductType.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:33 - -___ - -### AdminProductsRes - -Ƭ **AdminProductsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `product` | [`Product`](../classes/internal.Product.md) | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:39 - -___ - -### PricedProduct - -Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-16.md#pricedvariant)[] } - -#### Defined in - -medusa/dist/types/pricing.d.ts:28 - -___ - -### PricedVariant - -Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-16.md#productvariantpricing) - -#### Defined in - -medusa/dist/types/pricing.d.ts:27 - -___ - -### ProductVariantPricing - -Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-16.md#taxedpricing) - -#### Defined in - -medusa/dist/types/pricing.d.ts:4 - -___ - -### TaxServiceRate - -Ƭ **TaxServiceRate**: `Object` - -The tax rate object as configured in Medusa. These may have an unspecified -numerical rate as they may be used for lookup purposes in the tax provider -plugin. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `code` | `string` \| ``null`` | -| `name` | `string` | -| `rate?` | `number` \| ``null`` | - -#### Defined in - -medusa/dist/types/tax-service.d.ts:6 - -___ - -### TaxedPricing - -Ƭ **TaxedPricing**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `calculated_price_incl_tax` | `number` \| ``null`` | -| `calculated_tax` | `number` \| ``null`` | -| `original_price_incl_tax` | `number` \| ``null`` | -| `original_tax` | `number` \| ``null`` | -| `tax_rates` | [`TaxServiceRate`](internal-16.md#taxservicerate)[] \| ``null`` | - -#### Defined in - -medusa/dist/types/pricing.d.ts:10 +medusa/dist/api/routes/admin/product-tags/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-17.md b/docs/content/references/js-client/modules/internal-17.md index 5d4ae64605..e5033cb94c 100644 --- a/docs/content/references/js-client/modules/internal-17.md +++ b/docs/content/references/js-client/modules/internal-17.md @@ -2,23 +2,15 @@ ## Classes -- [AdminGetRegionsPaginationParams](../classes/internal-17.AdminGetRegionsPaginationParams.md) -- [AdminGetRegionsParams](../classes/internal-17.AdminGetRegionsParams.md) -- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md) -- [AdminPostRegionsRegionCountriesReq](../classes/internal-17.AdminPostRegionsRegionCountriesReq.md) -- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md) -- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md) -- [AdminPostRegionsRegionReq](../classes/internal-17.AdminPostRegionsRegionReq.md) -- [AdminPostRegionsReq](../classes/internal-17.AdminPostRegionsReq.md) -- [AdminRegionsRes](../classes/internal-17.AdminRegionsRes.md) -- [FulfillmentOption](../classes/internal-17.FulfillmentOption.md) +- [AdminGetProductTypesPaginationParams](../classes/internal-17.AdminGetProductTypesPaginationParams.md) +- [AdminGetProductTypesParams](../classes/internal-17.AdminGetProductTypesParams.md) ## Type Aliases -### AdminRegionsListRes +### AdminProductTypesListRes -Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] } +Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] } #### Defined in -medusa/dist/api/routes/admin/regions/index.d.ts:11 +medusa/dist/api/routes/admin/product-types/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-18.md b/docs/content/references/js-client/modules/internal-18.md index be5f59251e..2f741813fc 100644 --- a/docs/content/references/js-client/modules/internal-18.md +++ b/docs/content/references/js-client/modules/internal-18.md @@ -2,37 +2,210 @@ ## Classes -- [AdminPostReturnReasonsReasonReq](../classes/internal-18.AdminPostReturnReasonsReasonReq.md) -- [AdminPostReturnReasonsReq](../classes/internal-18.AdminPostReturnReasonsReq.md) +- [AdminGetProductsParams](../classes/internal-18.AdminGetProductsParams.md) +- [AdminPostProductsProductMetadataReq](../classes/internal-18.AdminPostProductsProductMetadataReq.md) +- [AdminPostProductsProductOptionsOption](../classes/internal-18.AdminPostProductsProductOptionsOption.md) +- [AdminPostProductsProductOptionsReq](../classes/internal-18.AdminPostProductsProductOptionsReq.md) +- [AdminPostProductsProductReq](../classes/internal-18.AdminPostProductsProductReq.md) +- [AdminPostProductsProductVariantsReq](../classes/internal-18.AdminPostProductsProductVariantsReq.md) +- [AdminPostProductsProductVariantsVariantReq](../classes/internal-18.AdminPostProductsProductVariantsVariantReq.md) +- [AdminPostProductsReq](../classes/internal-18.AdminPostProductsReq.md) +- [FilterableProductProps](../classes/internal-18.FilterableProductProps.md) +- [ProductOptionReq](../classes/internal-18.ProductOptionReq.md) +- [ProductSalesChannelReq](../classes/internal-18.ProductSalesChannelReq.md) +- [ProductTagReq](../classes/internal-18.ProductTagReq.md) +- [ProductTypeReq](../classes/internal-18.ProductTypeReq.md) +- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq.md) +- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-1.md) +- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-2.md) +- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-3.md) +- [ProductVariantPricesCreateReq](../classes/internal-18.ProductVariantPricesCreateReq.md) +- [ProductVariantPricesUpdateReq](../classes/internal-18.ProductVariantPricesUpdateReq.md) +- [ProductVariantReq](../classes/internal-18.ProductVariantReq.md) +- [ProductVariantReq](../classes/internal-18.ProductVariantReq-1.md) ## Type Aliases -### AdminReturnReasonsListRes +### AdminProductsDeleteOptionRes -Ƭ **AdminReturnReasonsListRes**: `Object` +Ƭ **AdminProductsDeleteOptionRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | +| `deleted` | `boolean` | +| `object` | ``"option"`` | +| `option_id` | `string` | +| `product` | [`Product`](../classes/internal.Product.md) | #### Defined in -medusa/dist/api/routes/admin/return-reasons/index.d.ts:10 +medusa/dist/api/routes/admin/products/index.d.ts:13 ___ -### AdminReturnReasonsRes +### AdminProductsDeleteRes -Ƭ **AdminReturnReasonsRes**: `Object` +Ƭ **AdminProductsDeleteRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | +| `deleted` | `boolean` | +| `id` | `string` | +| `object` | ``"product"`` | #### Defined in -medusa/dist/api/routes/admin/return-reasons/index.d.ts:7 +medusa/dist/api/routes/admin/products/index.d.ts:25 + +___ + +### AdminProductsDeleteVariantRes + +Ƭ **AdminProductsDeleteVariantRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `object` | ``"product-variant"`` | +| `product` | [`Product`](../classes/internal.Product.md) | +| `variant_id` | `string` | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:19 + +___ + +### AdminProductsListRes + +Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-18.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] } + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:30 + +___ + +### AdminProductsListTagsRes + +Ƭ **AdminProductsListTagsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:36 + +___ + +### AdminProductsListTypesRes + +Ƭ **AdminProductsListTypesRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `types` | [`ProductType`](../classes/internal.ProductType.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:33 + +___ + +### AdminProductsRes + +Ƭ **AdminProductsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `product` | [`Product`](../classes/internal.Product.md) | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:39 + +___ + +### PricedProduct + +Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-18.md#pricedvariant)[] } + +#### Defined in + +medusa/dist/types/pricing.d.ts:31 + +___ + +### PricedVariant + +Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-18.md#productvariantpricing) + +#### Defined in + +medusa/dist/types/pricing.d.ts:30 + +___ + +### ProductVariantPricing + +Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-18.md#taxedpricing) + +#### Defined in + +medusa/dist/types/pricing.d.ts:4 + +___ + +### TaxServiceRate + +Ƭ **TaxServiceRate**: `Object` + +The tax rate object as configured in Medusa. These may have an unspecified +numerical rate as they may be used for lookup purposes in the tax provider +plugin. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` \| ``null`` | +| `name` | `string` | +| `rate?` | `number` \| ``null`` | + +#### Defined in + +medusa/dist/types/tax-service.d.ts:6 + +___ + +### TaxedPricing + +Ƭ **TaxedPricing**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `calculated_price_incl_tax` | `number` \| ``null`` | +| `calculated_tax` | `number` \| ``null`` | +| `original_price_incl_tax` | `number` \| ``null`` | +| `original_tax` | `number` \| ``null`` | +| `tax_rates` | [`TaxServiceRate`](internal-18.md#taxservicerate)[] \| ``null`` | + +#### Defined in + +medusa/dist/types/pricing.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-19.md b/docs/content/references/js-client/modules/internal-19.md index fe202df01d..70f01f8378 100644 --- a/docs/content/references/js-client/modules/internal-19.md +++ b/docs/content/references/js-client/modules/internal-19.md @@ -2,48 +2,23 @@ ## Classes -- [AdminGetReturnsParams](../classes/internal-19.AdminGetReturnsParams.md) -- [AdminPostReturnsReturnReceiveReq](../classes/internal-19.AdminPostReturnsReturnReceiveReq.md) -- [Item](../classes/internal-19.Item.md) +- [AdminGetRegionsPaginationParams](../classes/internal-19.AdminGetRegionsPaginationParams.md) +- [AdminGetRegionsParams](../classes/internal-19.AdminGetRegionsParams.md) +- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md) +- [AdminPostRegionsRegionCountriesReq](../classes/internal-19.AdminPostRegionsRegionCountriesReq.md) +- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md) +- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md) +- [AdminPostRegionsRegionReq](../classes/internal-19.AdminPostRegionsRegionReq.md) +- [AdminPostRegionsReq](../classes/internal-19.AdminPostRegionsReq.md) +- [AdminRegionsRes](../classes/internal-19.AdminRegionsRes.md) +- [FulfillmentOption](../classes/internal-19.FulfillmentOption.md) ## Type Aliases -### AdminReturnsCancelRes +### AdminRegionsListRes -Ƭ **AdminReturnsCancelRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | +Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] } #### Defined in -medusa/dist/api/routes/admin/returns/index.d.ts:6 - -___ - -### AdminReturnsListRes - -Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/returns/index.d.ts:9 - -___ - -### AdminReturnsRes - -Ƭ **AdminReturnsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return` | [`Return`](../classes/internal.Return.md) | - -#### Defined in - -medusa/dist/api/routes/admin/returns/index.d.ts:12 +medusa/dist/api/routes/admin/regions/index.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-2.md b/docs/content/references/js-client/modules/internal-2.md index 3ef56408f1..2eda5e731a 100644 --- a/docs/content/references/js-client/modules/internal-2.md +++ b/docs/content/references/js-client/modules/internal-2.md @@ -93,4 +93,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:59 +medusa/dist/types/common.d.ts:60 diff --git a/docs/content/references/js-client/modules/internal-20.md b/docs/content/references/js-client/modules/internal-20.md index 751556861d..034da63bd0 100644 --- a/docs/content/references/js-client/modules/internal-20.md +++ b/docs/content/references/js-client/modules/internal-20.md @@ -2,45 +2,37 @@ ## Classes -- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md) -- [AdminGetSalesChannelsParams](../classes/internal-20.AdminGetSalesChannelsParams.md) -- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md) -- [AdminPostSalesChannelsReq](../classes/internal-20.AdminPostSalesChannelsReq.md) -- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md) -- [ProductBatchSalesChannel](../classes/internal-20.ProductBatchSalesChannel.md) +- [AdminPostReturnReasonsReasonReq](../classes/internal-20.AdminPostReturnReasonsReasonReq.md) +- [AdminPostReturnReasonsReq](../classes/internal-20.AdminPostReturnReasonsReq.md) ## Type Aliases -### AdminSalesChannelsListRes +### AdminReturnReasonsListRes -Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/index.d.ts:10 - -___ - -### AdminSalesChannelsRes - -Ƭ **AdminSalesChannelsRes**: `Object` +Ƭ **AdminReturnReasonsListRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) | +| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | #### Defined in -medusa/dist/api/routes/admin/sales-channels/index.d.ts:6 +medusa/dist/api/routes/admin/return-reasons/index.d.ts:10 -## Variables +___ -### AdminGetSalesChannelsParams\_base +### AdminReturnReasonsRes -• `Const` **AdminGetSalesChannelsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) +Ƭ **AdminReturnReasonsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:110 +medusa/dist/api/routes/admin/return-reasons/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-21.md b/docs/content/references/js-client/modules/internal-21.md index 5f259ae622..03818fa624 100644 --- a/docs/content/references/js-client/modules/internal-21.md +++ b/docs/content/references/js-client/modules/internal-21.md @@ -2,34 +2,48 @@ ## Classes -- [AdminGetShippingOptionsParams](../classes/internal-21.AdminGetShippingOptionsParams.md) -- [AdminPostShippingOptionsOptionReq](../classes/internal-21.AdminPostShippingOptionsOptionReq.md) -- [AdminPostShippingOptionsReq](../classes/internal-21.AdminPostShippingOptionsReq.md) -- [OptionRequirement](../classes/internal-21.OptionRequirement.md) -- [OptionRequirement](../classes/internal-21.OptionRequirement-1.md) +- [AdminGetReturnsParams](../classes/internal-21.AdminGetReturnsParams.md) +- [AdminPostReturnsReturnReceiveReq](../classes/internal-21.AdminPostReturnsReturnReceiveReq.md) +- [Item](../classes/internal-21.Item.md) ## Type Aliases -### AdminShippingOptionsListRes +### AdminReturnsCancelRes -Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/index.d.ts:7 - -___ - -### AdminShippingOptionsRes - -Ƭ **AdminShippingOptionsRes**: `Object` +Ƭ **AdminReturnsCancelRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) | +| `order` | [`Order`](../classes/internal.Order.md) | #### Defined in -medusa/dist/api/routes/admin/shipping-options/index.d.ts:10 +medusa/dist/api/routes/admin/returns/index.d.ts:6 + +___ + +### AdminReturnsListRes + +Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/returns/index.d.ts:9 + +___ + +### AdminReturnsRes + +Ƭ **AdminReturnsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return` | [`Return`](../classes/internal.Return.md) | + +#### Defined in + +medusa/dist/api/routes/admin/returns/index.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-22.md b/docs/content/references/js-client/modules/internal-22.md index 53e1b6a6a6..b49d3384e7 100644 --- a/docs/content/references/js-client/modules/internal-22.md +++ b/docs/content/references/js-client/modules/internal-22.md @@ -2,37 +2,45 @@ ## Classes -- [AdminPostShippingProfilesProfileReq](../classes/internal-22.AdminPostShippingProfilesProfileReq.md) -- [AdminPostShippingProfilesReq](../classes/internal-22.AdminPostShippingProfilesReq.md) +- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md) +- [AdminGetSalesChannelsParams](../classes/internal-22.AdminGetSalesChannelsParams.md) +- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md) +- [AdminPostSalesChannelsReq](../classes/internal-22.AdminPostSalesChannelsReq.md) +- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md) +- [ProductBatchSalesChannel](../classes/internal-22.ProductBatchSalesChannel.md) ## Type Aliases -### AdminShippingProfilesListRes +### AdminSalesChannelsListRes -Ƭ **AdminShippingProfilesListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] | +Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] } #### Defined in -medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12 +medusa/dist/api/routes/admin/sales-channels/index.d.ts:10 ___ -### AdminShippingProfilesRes +### AdminSalesChannelsRes -Ƭ **AdminShippingProfilesRes**: `Object` +Ƭ **AdminSalesChannelsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) | +| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) | #### Defined in -medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9 +medusa/dist/api/routes/admin/sales-channels/index.d.ts:6 + +## Variables + +### AdminGetSalesChannelsParams\_base + +• `Const` **AdminGetSalesChannelsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:141 diff --git a/docs/content/references/js-client/modules/internal-23.md b/docs/content/references/js-client/modules/internal-23.md index 138a586dd0..2d08b3547e 100644 --- a/docs/content/references/js-client/modules/internal-23.md +++ b/docs/content/references/js-client/modules/internal-23.md @@ -2,53 +2,34 @@ ## Classes -- [AdminPostStoreReq](../classes/internal-23.AdminPostStoreReq.md) -- [Store](../classes/internal-23.Store.md) +- [AdminGetShippingOptionsParams](../classes/internal-23.AdminGetShippingOptionsParams.md) +- [AdminPostShippingOptionsOptionReq](../classes/internal-23.AdminPostShippingOptionsOptionReq.md) +- [AdminPostShippingOptionsReq](../classes/internal-23.AdminPostShippingOptionsReq.md) +- [OptionRequirement](../classes/internal-23.OptionRequirement.md) +- [OptionRequirement](../classes/internal-23.OptionRequirement-1.md) ## Type Aliases -### AdminPaymentProvidersList +### AdminShippingOptionsListRes -Ƭ **AdminPaymentProvidersList**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] | +Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] } #### Defined in -medusa/dist/api/routes/admin/store/index.d.ts:10 +medusa/dist/api/routes/admin/shipping-options/index.d.ts:8 ___ -### AdminStoresRes +### AdminShippingOptionsRes -Ƭ **AdminStoresRes**: `Object` +Ƭ **AdminShippingOptionsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `store` | [`Store`](../classes/internal-23.Store.md) | +| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) | #### Defined in -medusa/dist/api/routes/admin/store/index.d.ts:4 - -___ - -### AdminTaxProvidersList - -Ƭ **AdminTaxProvidersList**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/store/index.d.ts:7 +medusa/dist/api/routes/admin/shipping-options/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-24.md b/docs/content/references/js-client/modules/internal-24.md index 0e24b097ec..e45927ec04 100644 --- a/docs/content/references/js-client/modules/internal-24.md +++ b/docs/content/references/js-client/modules/internal-24.md @@ -2,30 +2,37 @@ ## Classes -- [AdminGetSwapsParams](../classes/internal-24.AdminGetSwapsParams.md) +- [AdminPostShippingProfilesProfileReq](../classes/internal-24.AdminPostShippingProfilesProfileReq.md) +- [AdminPostShippingProfilesReq](../classes/internal-24.AdminPostShippingProfilesReq.md) ## Type Aliases -### AdminSwapsListRes +### AdminShippingProfilesListRes -Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/swaps/index.d.ts:7 - -___ - -### AdminSwapsRes - -Ƭ **AdminSwapsRes**: `Object` +Ƭ **AdminShippingProfilesListRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `swap` | [`Swap`](../classes/internal.Swap.md) | +| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] | #### Defined in -medusa/dist/api/routes/admin/swaps/index.d.ts:10 +medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12 + +___ + +### AdminShippingProfilesRes + +Ƭ **AdminShippingProfilesRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) | + +#### Defined in + +medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-25.md b/docs/content/references/js-client/modules/internal-25.md index e0f6da1541..96f26535e7 100644 --- a/docs/content/references/js-client/modules/internal-25.md +++ b/docs/content/references/js-client/modules/internal-25.md @@ -2,43 +2,53 @@ ## Classes -- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md) -- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md) -- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md) -- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md) -- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) -- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) -- [AdminGetTaxRatesParams](../classes/internal-25.AdminGetTaxRatesParams.md) -- [AdminGetTaxRatesTaxRateParams](../classes/internal-25.AdminGetTaxRatesTaxRateParams.md) -- [AdminPostTaxRatesReq](../classes/internal-25.AdminPostTaxRatesReq.md) -- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md) -- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md) -- [AdminPostTaxRatesTaxRateReq](../classes/internal-25.AdminPostTaxRatesTaxRateReq.md) -- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md) -- [NumericalComparisonOperator](../classes/internal-25.NumericalComparisonOperator.md) +- [AdminPostStoreReq](../classes/internal-25.AdminPostStoreReq.md) +- [Store](../classes/internal-25.Store.md) ## Type Aliases -### AdminTaxRatesListRes +### AdminPaymentProvidersList -Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/index.d.ts:8 - -___ - -### AdminTaxRatesRes - -Ƭ **AdminTaxRatesRes**: `Object` +Ƭ **AdminPaymentProvidersList**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) | +| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] | #### Defined in -medusa/dist/api/routes/admin/tax-rates/index.d.ts:11 +medusa/dist/api/routes/admin/store/index.d.ts:10 + +___ + +### AdminStoresRes + +Ƭ **AdminStoresRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `store` | [`Store`](../classes/internal-25.Store.md) | + +#### Defined in + +medusa/dist/api/routes/admin/store/index.d.ts:4 + +___ + +### AdminTaxProvidersList + +Ƭ **AdminTaxProvidersList**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/store/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-26.md b/docs/content/references/js-client/modules/internal-26.md index f144fda7f1..23cb3b8dc7 100644 --- a/docs/content/references/js-client/modules/internal-26.md +++ b/docs/content/references/js-client/modules/internal-26.md @@ -2,38 +2,30 @@ ## Classes -- [AdminDeleteUploadsReq](../classes/internal-26.AdminDeleteUploadsReq.md) -- [AdminPostUploadsDownloadUrlReq](../classes/internal-26.AdminPostUploadsDownloadUrlReq.md) -- [IAdminPostUploadsFileReq](../classes/internal-26.IAdminPostUploadsFileReq.md) +- [AdminGetSwapsParams](../classes/internal-26.AdminGetSwapsParams.md) ## Type Aliases -### AdminUploadsDownloadUrlRes +### AdminSwapsListRes -Ƭ **AdminUploadsDownloadUrlRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `download_url` | `string` | +Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] } #### Defined in -medusa/dist/api/routes/admin/uploads/index.d.ts:10 +medusa/dist/api/routes/admin/swaps/index.d.ts:7 ___ -### AdminUploadsRes +### AdminSwapsRes -Ƭ **AdminUploadsRes**: `Object` +Ƭ **AdminSwapsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `uploads` | { `url`: `string` }[] | +| `swap` | [`Swap`](../classes/internal.Swap.md) | #### Defined in -medusa/dist/api/routes/admin/uploads/index.d.ts:4 +medusa/dist/api/routes/admin/swaps/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-27.md b/docs/content/references/js-client/modules/internal-27.md index d86536a073..8dbc33fe8d 100644 --- a/docs/content/references/js-client/modules/internal-27.md +++ b/docs/content/references/js-client/modules/internal-27.md @@ -2,115 +2,43 @@ ## Classes -- [AdminCreateUserRequest](../classes/internal-27.AdminCreateUserRequest.md) -- [AdminResetPasswordRequest](../classes/internal-27.AdminResetPasswordRequest.md) -- [AdminResetPasswordTokenRequest](../classes/internal-27.AdminResetPasswordTokenRequest.md) -- [AdminUpdateUserRequest](../classes/internal-27.AdminUpdateUserRequest.md) +- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md) +- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md) +- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md) +- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md) +- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) +- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) +- [AdminGetTaxRatesParams](../classes/internal-27.AdminGetTaxRatesParams.md) +- [AdminGetTaxRatesTaxRateParams](../classes/internal-27.AdminGetTaxRatesTaxRateParams.md) +- [AdminPostTaxRatesReq](../classes/internal-27.AdminPostTaxRatesReq.md) +- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md) +- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md) +- [AdminPostTaxRatesTaxRateReq](../classes/internal-27.AdminPostTaxRatesTaxRateReq.md) +- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md) +- [NumericalComparisonOperator](../classes/internal-27.NumericalComparisonOperator.md) ## Type Aliases -### AdminCreateUserPayload +### AdminTaxRatesListRes -Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-27.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-27.md#createuserroles) } +Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] } #### Defined in -[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L31) +medusa/dist/api/routes/admin/tax-rates/index.d.ts:8 ___ -### AdminUpdateUserPayload +### AdminTaxRatesRes -Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-27.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-27.md#updateuserroles) } - -#### Defined in - -[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L41) - -___ - -### AdminUserRes - -Ƭ **AdminUserRes**: `Object` +Ƭ **AdminTaxRatesRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | +| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) | #### Defined in -medusa/dist/api/routes/admin/users/index.d.ts:6 - -___ - -### AdminUsersListRes - -Ƭ **AdminUsersListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] | - -#### Defined in - -medusa/dist/api/routes/admin/users/index.d.ts:9 - -___ - -### CreateUserRoles - -Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\` - -#### Defined in - -[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L28) - -___ - -### CreateUserRolesEnum - -Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-27.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-27.AdminCreateUserRequest.md)[``"role"``]\> - -#### Defined in - -[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L25) - -___ - -### NoUndefined - -Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L23) - -___ - -### UpdateUserRoles - -Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` - -#### Defined in - -[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L39) - -___ - -### UpdateUserRolesEnum - -Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-27.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-27.AdminUpdateUserRequest.md)[``"role"``]\> - -#### Defined in - -[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L37) +medusa/dist/api/routes/admin/tax-rates/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-28.md b/docs/content/references/js-client/modules/internal-28.md index dfecd2ff35..731ee69a92 100644 --- a/docs/content/references/js-client/modules/internal-28.md +++ b/docs/content/references/js-client/modules/internal-28.md @@ -2,14 +2,38 @@ ## Classes -- [AdminGetVariantsParams](../classes/internal-28.AdminGetVariantsParams.md) +- [AdminDeleteUploadsReq](../classes/internal-28.AdminDeleteUploadsReq.md) +- [AdminPostUploadsDownloadUrlReq](../classes/internal-28.AdminPostUploadsDownloadUrlReq.md) +- [IAdminPostUploadsFileReq](../classes/internal-28.IAdminPostUploadsFileReq.md) ## Type Aliases -### AdminVariantsListRes +### AdminUploadsDownloadUrlRes -Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] } +Ƭ **AdminUploadsDownloadUrlRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `download_url` | `string` | #### Defined in -medusa/dist/api/routes/admin/variants/index.d.ts:9 +medusa/dist/api/routes/admin/uploads/index.d.ts:10 + +___ + +### AdminUploadsRes + +Ƭ **AdminUploadsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `uploads` | { `url`: `string` }[] | + +#### Defined in + +medusa/dist/api/routes/admin/uploads/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-29.md b/docs/content/references/js-client/modules/internal-29.md index a37efa8968..079c2c38f0 100644 --- a/docs/content/references/js-client/modules/internal-29.md +++ b/docs/content/references/js-client/modules/internal-29.md @@ -2,36 +2,115 @@ ## Classes -- [StorePostAuthReq](../classes/internal-29.StorePostAuthReq.md) +- [AdminCreateUserRequest](../classes/internal-29.AdminCreateUserRequest.md) +- [AdminResetPasswordRequest](../classes/internal-29.AdminResetPasswordRequest.md) +- [AdminResetPasswordTokenRequest](../classes/internal-29.AdminResetPasswordTokenRequest.md) +- [AdminUpdateUserRequest](../classes/internal-29.AdminUpdateUserRequest.md) ## Type Aliases -### StoreAuthRes +### AdminCreateUserPayload -Ƭ **StoreAuthRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `customer` | [`Customer`](../classes/internal.Customer.md) | +Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-29.md#createuserroles) } #### Defined in -medusa/dist/api/routes/store/auth/index.d.ts:4 +[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L31) ___ -### StoreGetAuthEmailRes +### AdminUpdateUserPayload -Ƭ **StoreGetAuthEmailRes**: `Object` +Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-29.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-29.md#updateuserroles) } + +#### Defined in + +[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L41) + +___ + +### AdminUserRes + +Ƭ **AdminUserRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `exists` | `boolean` | +| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | #### Defined in -medusa/dist/api/routes/store/auth/index.d.ts:7 +medusa/dist/api/routes/admin/users/index.d.ts:6 + +___ + +### AdminUsersListRes + +Ƭ **AdminUsersListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] | + +#### Defined in + +medusa/dist/api/routes/admin/users/index.d.ts:9 + +___ + +### CreateUserRoles + +Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\` + +#### Defined in + +[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L28) + +___ + +### CreateUserRolesEnum + +Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-29.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md)[``"role"``]\> + +#### Defined in + +[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L25) + +___ + +### NoUndefined + +Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L23) + +___ + +### UpdateUserRoles + +Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` + +#### Defined in + +[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L39) + +___ + +### UpdateUserRolesEnum + +Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-29.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-29.AdminUpdateUserRequest.md)[``"role"``]\> + +#### Defined in + +[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L37) diff --git a/docs/content/references/js-client/modules/internal-3.md b/docs/content/references/js-client/modules/internal-3.md index 4c49d0f988..9e09aae20b 100644 --- a/docs/content/references/js-client/modules/internal-3.md +++ b/docs/content/references/js-client/modules/internal-3.md @@ -51,4 +51,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:64 +medusa/dist/types/common.d.ts:65 diff --git a/docs/content/references/js-client/modules/internal-30.md b/docs/content/references/js-client/modules/internal-30.md index fc85db61a9..c879adbcc9 100644 --- a/docs/content/references/js-client/modules/internal-30.md +++ b/docs/content/references/js-client/modules/internal-30.md @@ -2,37 +2,14 @@ ## Classes -- [Discount](../classes/internal-30.Discount.md) -- [GiftCard](../classes/internal-30.GiftCard.md) -- [Item](../classes/internal-30.Item.md) -- [StorePostCartReq](../classes/internal-30.StorePostCartReq.md) -- [StorePostCartsCartPaymentSessionReq](../classes/internal-30.StorePostCartsCartPaymentSessionReq.md) -- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md) -- [StorePostCartsCartReq](../classes/internal-30.StorePostCartsCartReq.md) -- [StorePostCartsCartShippingMethodReq](../classes/internal-30.StorePostCartsCartShippingMethodReq.md) +- [AdminGetVariantsParams](../classes/internal-30.AdminGetVariantsParams.md) ## Type Aliases -### StoreCartsRes +### AdminVariantsListRes -Ƭ **StoreCartsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> | +Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] } #### Defined in -medusa/dist/api/routes/store/carts/index.d.ts:8 - -___ - -### StoreCompleteCartRes - -Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` } - -#### Defined in - -medusa/dist/api/routes/store/carts/index.d.ts:11 +medusa/dist/api/routes/admin/variants/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-31.md b/docs/content/references/js-client/modules/internal-31.md index 4d03367a70..d10d57a1b8 100644 --- a/docs/content/references/js-client/modules/internal-31.md +++ b/docs/content/references/js-client/modules/internal-31.md @@ -2,30 +2,36 @@ ## Classes -- [StoreGetCollectionsParams](../classes/internal-31.StoreGetCollectionsParams.md) +- [StorePostAuthReq](../classes/internal-31.StorePostAuthReq.md) ## Type Aliases -### StoreCollectionsListRes +### StoreAuthRes -Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] } - -#### Defined in - -medusa/dist/api/routes/store/collections/index.d.ts:7 - -___ - -### StoreCollectionsRes - -Ƭ **StoreCollectionsRes**: `Object` +Ƭ **StoreAuthRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) | +| `customer` | [`Customer`](../classes/internal.Customer.md) | #### Defined in -medusa/dist/api/routes/store/collections/index.d.ts:10 +medusa/dist/api/routes/store/auth/index.d.ts:4 + +___ + +### StoreGetAuthEmailRes + +Ƭ **StoreGetAuthEmailRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exists` | `boolean` | + +#### Defined in + +medusa/dist/api/routes/store/auth/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-32.md b/docs/content/references/js-client/modules/internal-32.md index e4e50ee0a5..987d72df8d 100644 --- a/docs/content/references/js-client/modules/internal-32.md +++ b/docs/content/references/js-client/modules/internal-32.md @@ -2,18 +2,37 @@ ## Classes -- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md) -- [StoreGetCustomersCustomerOrdersParams](../classes/internal-32.StoreGetCustomersCustomerOrdersParams.md) -- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md) -- [StorePostCustomersCustomerReq](../classes/internal-32.StorePostCustomersCustomerReq.md) -- [StorePostCustomersReq](../classes/internal-32.StorePostCustomersReq.md) +- [Discount](../classes/internal-32.Discount.md) +- [GiftCard](../classes/internal-32.GiftCard.md) +- [Item](../classes/internal-32.Item.md) +- [StorePostCartReq](../classes/internal-32.StorePostCartReq.md) +- [StorePostCartsCartPaymentSessionReq](../classes/internal-32.StorePostCartsCartPaymentSessionReq.md) +- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md) +- [StorePostCartsCartReq](../classes/internal-32.StorePostCartsCartReq.md) +- [StorePostCartsCartShippingMethodReq](../classes/internal-32.StorePostCartsCartShippingMethodReq.md) ## Type Aliases -### StoreCustomersListOrdersRes +### StoreCartsRes -Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } +Ƭ **StoreCartsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> | #### Defined in -medusa/dist/api/routes/store/customers/index.d.ts:12 +medusa/dist/api/routes/store/carts/index.d.ts:8 + +___ + +### StoreCompleteCartRes + +Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` } + +#### Defined in + +medusa/dist/api/routes/store/carts/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-33.md b/docs/content/references/js-client/modules/internal-33.md index 52a8616e22..301fdceb62 100644 --- a/docs/content/references/js-client/modules/internal-33.md +++ b/docs/content/references/js-client/modules/internal-33.md @@ -1,17 +1,31 @@ # Namespace: internal +## Classes + +- [StoreGetCollectionsParams](../classes/internal-33.StoreGetCollectionsParams.md) + ## Type Aliases -### StoreGiftCardsRes +### StoreCollectionsListRes -Ƭ **StoreGiftCardsRes**: `Object` +Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] } + +#### Defined in + +medusa/dist/api/routes/store/collections/index.d.ts:7 + +___ + +### StoreCollectionsRes + +Ƭ **StoreCollectionsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | +| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) | #### Defined in -medusa/dist/api/routes/store/gift-cards/index.d.ts:8 +medusa/dist/api/routes/store/collections/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-34.md b/docs/content/references/js-client/modules/internal-34.md index 8965788ee0..f01382088e 100644 --- a/docs/content/references/js-client/modules/internal-34.md +++ b/docs/content/references/js-client/modules/internal-34.md @@ -2,5 +2,19 @@ ## Classes -- [StorePostCartsCartLineItemsItemReq](../classes/internal-34.StorePostCartsCartLineItemsItemReq.md) -- [StorePostCartsCartLineItemsReq](../classes/internal-34.StorePostCartsCartLineItemsReq.md) +- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md) +- [StoreGetCustomersCustomerOrdersParams](../classes/internal-34.StoreGetCustomersCustomerOrdersParams.md) +- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md) +- [StorePostCustomersCustomerReq](../classes/internal-34.StorePostCustomersCustomerReq.md) +- [StorePostCustomersReq](../classes/internal-34.StorePostCustomersReq.md) +- [StorePostCustomersResetPasswordReq](../classes/internal-34.StorePostCustomersResetPasswordReq.md) + +## Type Aliases + +### StoreCustomersListOrdersRes + +Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } + +#### Defined in + +medusa/dist/api/routes/store/customers/index.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-35.md b/docs/content/references/js-client/modules/internal-35.md index 1e9186a1d8..52a8616e22 100644 --- a/docs/content/references/js-client/modules/internal-35.md +++ b/docs/content/references/js-client/modules/internal-35.md @@ -1,22 +1,17 @@ # Namespace: internal -## Classes - -- [ShippingAddressPayload](../classes/internal-35.ShippingAddressPayload.md) -- [StoreGetOrdersParams](../classes/internal-35.StoreGetOrdersParams.md) - ## Type Aliases -### StoreOrdersRes +### StoreGiftCardsRes -Ƭ **StoreOrdersRes**: `Object` +Ƭ **StoreGiftCardsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | +| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | #### Defined in -medusa/dist/api/routes/store/orders/index.d.ts:9 +medusa/dist/api/routes/store/gift-cards/index.d.ts:8 diff --git a/docs/content/references/js-client/modules/internal-36.md b/docs/content/references/js-client/modules/internal-36.md index 4c6cd3245f..b0bdadde0c 100644 --- a/docs/content/references/js-client/modules/internal-36.md +++ b/docs/content/references/js-client/modules/internal-36.md @@ -1,17 +1,6 @@ # Namespace: internal -## Type Aliases +## Classes -### StoreCustomersListPaymentMethodsRes - -Ƭ **StoreCustomersListPaymentMethodsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] | - -#### Defined in - -medusa/dist/api/routes/store/customers/index.d.ts:15 +- [StorePostCartsCartLineItemsItemReq](../classes/internal-36.StorePostCartsCartLineItemsItemReq.md) +- [StorePostCartsCartLineItemsReq](../classes/internal-36.StorePostCartsCartLineItemsReq.md) diff --git a/docs/content/references/js-client/modules/internal-37.md b/docs/content/references/js-client/modules/internal-37.md index 1d9b7ae74f..40ad722772 100644 --- a/docs/content/references/js-client/modules/internal-37.md +++ b/docs/content/references/js-client/modules/internal-37.md @@ -2,31 +2,20 @@ ## Classes -- [PriceSelectionParams](../classes/internal-37.PriceSelectionParams.md) -- [StoreGetVariantsParams](../classes/internal-37.StoreGetVariantsParams.md) +- [StorePostOrderEditsOrderEditDecline](../classes/internal-37.StorePostOrderEditsOrderEditDecline.md) ## Type Aliases -### StoreVariantsListRes +### StoreOrderEditsRes -Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] } - -#### Defined in - -medusa/dist/api/routes/store/variants/index.d.ts:9 - -___ - -### StoreVariantsRes - -Ƭ **StoreVariantsRes**: `Object` +Ƭ **StoreOrderEditsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) | +| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> | #### Defined in -medusa/dist/api/routes/store/variants/index.d.ts:6 +medusa/dist/api/routes/store/order-edits/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-38.md b/docs/content/references/js-client/modules/internal-38.md index c6ac24c225..7407660859 100644 --- a/docs/content/references/js-client/modules/internal-38.md +++ b/docs/content/references/js-client/modules/internal-38.md @@ -2,52 +2,21 @@ ## Classes -- [StoreGetProductsPaginationParams](../classes/internal-38.StoreGetProductsPaginationParams.md) -- [StoreGetProductsParams](../classes/internal-38.StoreGetProductsParams.md) -- [StorePostSearchReq](../classes/internal-38.StorePostSearchReq.md) +- [ShippingAddressPayload](../classes/internal-38.ShippingAddressPayload.md) +- [StoreGetOrdersParams](../classes/internal-38.StoreGetOrdersParams.md) ## Type Aliases -### StorePostSearchRes +### StoreOrdersRes -Ƭ **StorePostSearchRes**: `Object` - -#### Index signature - -▪ [k: `string`]: `unknown` +Ƭ **StoreOrdersRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `hits` | `unknown`[] | +| `order` | [`Order`](../classes/internal.Order.md) | #### Defined in -medusa/dist/api/routes/store/products/index.d.ts:12 - -___ - -### StoreProductsListRes - -Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] } - -#### Defined in - -medusa/dist/api/routes/store/products/index.d.ts:16 - -___ - -### StoreProductsRes - -Ƭ **StoreProductsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `product` | [`Product`](../classes/internal.Product.md) | - -#### Defined in - -medusa/dist/api/routes/store/products/index.d.ts:9 +medusa/dist/api/routes/store/orders/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-39.md b/docs/content/references/js-client/modules/internal-39.md index 1235343f30..4c6cd3245f 100644 --- a/docs/content/references/js-client/modules/internal-39.md +++ b/docs/content/references/js-client/modules/internal-39.md @@ -2,32 +2,16 @@ ## Type Aliases -### StoreRegionsListRes +### StoreCustomersListPaymentMethodsRes -Ƭ **StoreRegionsListRes**: `Object` +Ƭ **StoreCustomersListPaymentMethodsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `regions` | [`Region`](../classes/internal.Region.md)[] | +| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] | #### Defined in -medusa/dist/api/routes/store/regions/index.d.ts:4 - -___ - -### StoreRegionsRes - -Ƭ **StoreRegionsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `region` | [`Region`](../classes/internal.Region.md) | - -#### Defined in - -medusa/dist/api/routes/store/regions/index.d.ts:7 +medusa/dist/api/routes/store/customers/index.d.ts:15 diff --git a/docs/content/references/js-client/modules/internal-4.md b/docs/content/references/js-client/modules/internal-4.md index 28559e69fd..2742c7ffdd 100644 --- a/docs/content/references/js-client/modules/internal-4.md +++ b/docs/content/references/js-client/modules/internal-4.md @@ -2,51 +2,32 @@ ## Classes -- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) -- [AdminGetCustomerGroupsGroupParams](../classes/internal-4.AdminGetCustomerGroupsGroupParams.md) -- [AdminGetCustomerGroupsParams](../classes/internal-4.AdminGetCustomerGroupsParams.md) -- [AdminGetCustomersParams](../classes/internal-4.AdminGetCustomersParams.md) -- [AdminListCustomerSelector](../classes/internal-4.AdminListCustomerSelector.md) -- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md) -- [AdminPostCustomerGroupsGroupReq](../classes/internal-4.AdminPostCustomerGroupsGroupReq.md) -- [AdminPostCustomerGroupsReq](../classes/internal-4.AdminPostCustomerGroupsReq.md) -- [CustomerGroupsBatchCustomer](../classes/internal-4.CustomerGroupsBatchCustomer.md) -- [FilterableCustomerGroupProps](../classes/internal-4.FilterableCustomerGroupProps.md) -- [FindParams](../classes/internal-4.FindParams.md) -- [StringComparisonOperator](../classes/internal-4.StringComparisonOperator.md) +- [AdminGetCurrenciesParams](../classes/internal-4.AdminGetCurrenciesParams.md) +- [AdminPostCurrenciesCurrencyReq](../classes/internal-4.AdminPostCurrenciesCurrencyReq.md) +- [FindPaginationParams](../classes/internal-4.FindPaginationParams.md) ## Type Aliases -### AdminCustomerGroupsListRes +### AdminCurrenciesListRes -Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal.CustomerGroup.md)[] } +Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `currencies`: [`Currency`](../classes/internal.Currency.md)[] } #### Defined in -medusa/dist/api/routes/admin/customer-groups/index.d.ts:9 +medusa/dist/api/routes/admin/currencies/index.d.ts:5 ___ -### AdminCustomerGroupsRes +### AdminCurrenciesRes -Ƭ **AdminCustomerGroupsRes**: `Object` +Ƭ **AdminCurrenciesRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `customer_group` | [`CustomerGroup`](../classes/internal.CustomerGroup.md) | +| `currency` | [`Currency`](../classes/internal.Currency.md) | #### Defined in -medusa/dist/api/routes/admin/customer-groups/index.d.ts:5 - -___ - -### AdminCustomersListRes - -Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal.Customer.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/customers/index.d.ts:9 +medusa/dist/api/routes/admin/currencies/index.d.ts:8 diff --git a/docs/content/references/js-client/modules/internal-40.md b/docs/content/references/js-client/modules/internal-40.md index 20dac0fd61..0ba99e0e09 100644 --- a/docs/content/references/js-client/modules/internal-40.md +++ b/docs/content/references/js-client/modules/internal-40.md @@ -1,33 +1,32 @@ # Namespace: internal +## Classes + +- [PriceSelectionParams](../classes/internal-40.PriceSelectionParams.md) +- [StoreGetVariantsParams](../classes/internal-40.StoreGetVariantsParams.md) + ## Type Aliases -### StoreReturnReasonsListRes +### StoreVariantsListRes -Ƭ **StoreReturnReasonsListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | +Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] } #### Defined in -medusa/dist/api/routes/store/return-reasons/index.d.ts:6 +medusa/dist/api/routes/store/variants/index.d.ts:9 ___ -### StoreReturnReasonsRes +### StoreVariantsRes -Ƭ **StoreReturnReasonsRes**: `Object` +Ƭ **StoreVariantsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | +| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) | #### Defined in -medusa/dist/api/routes/store/return-reasons/index.d.ts:9 +medusa/dist/api/routes/store/variants/index.d.ts:6 diff --git a/docs/content/references/js-client/modules/internal-41.md b/docs/content/references/js-client/modules/internal-41.md index 53cd2ac774..be69114c1d 100644 --- a/docs/content/references/js-client/modules/internal-41.md +++ b/docs/content/references/js-client/modules/internal-41.md @@ -2,22 +2,52 @@ ## Classes -- [Item](../classes/internal-41.Item.md) -- [ReturnShipping](../classes/internal-41.ReturnShipping.md) -- [StorePostReturnsReq](../classes/internal-41.StorePostReturnsReq.md) +- [StoreGetProductsPaginationParams](../classes/internal-41.StoreGetProductsPaginationParams.md) +- [StoreGetProductsParams](../classes/internal-41.StoreGetProductsParams.md) +- [StorePostSearchReq](../classes/internal-41.StorePostSearchReq.md) ## Type Aliases -### StoreReturnsRes +### StorePostSearchRes -Ƭ **StoreReturnsRes**: `Object` +Ƭ **StorePostSearchRes**: `Object` + +#### Index signature + +▪ [k: `string`]: `unknown` #### Type declaration | Name | Type | | :------ | :------ | -| `return` | [`Return`](../classes/internal.Return.md) | +| `hits` | `unknown`[] | #### Defined in -medusa/dist/api/routes/store/returns/index.d.ts:4 +medusa/dist/api/routes/store/products/index.d.ts:12 + +___ + +### StoreProductsListRes + +Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] } + +#### Defined in + +medusa/dist/api/routes/store/products/index.d.ts:16 + +___ + +### StoreProductsRes + +Ƭ **StoreProductsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `product` | [`Product`](../classes/internal.Product.md) | + +#### Defined in + +medusa/dist/api/routes/store/products/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-42.md b/docs/content/references/js-client/modules/internal-42.md index 2ea7afa7bd..1235343f30 100644 --- a/docs/content/references/js-client/modules/internal-42.md +++ b/docs/content/references/js-client/modules/internal-42.md @@ -1,21 +1,33 @@ # Namespace: internal -## Classes - -- [StoreGetShippingOptionsParams](../classes/internal-42.StoreGetShippingOptionsParams.md) - ## Type Aliases -### StoreShippingOptionsListRes +### StoreRegionsListRes -Ƭ **StoreShippingOptionsListRes**: `Object` +Ƭ **StoreRegionsListRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] | +| `regions` | [`Region`](../classes/internal.Region.md)[] | #### Defined in -medusa/dist/api/routes/store/shipping-options/index.d.ts:4 +medusa/dist/api/routes/store/regions/index.d.ts:4 + +___ + +### StoreRegionsRes + +Ƭ **StoreRegionsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `region` | [`Region`](../classes/internal.Region.md) | + +#### Defined in + +medusa/dist/api/routes/store/regions/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-43.md b/docs/content/references/js-client/modules/internal-43.md index 86ac68a54c..20dac0fd61 100644 --- a/docs/content/references/js-client/modules/internal-43.md +++ b/docs/content/references/js-client/modules/internal-43.md @@ -1,23 +1,33 @@ # Namespace: internal -## Classes - -- [AdditionalItem](../classes/internal-43.AdditionalItem.md) -- [Item](../classes/internal-43.Item.md) -- [StorePostSwapsReq](../classes/internal-43.StorePostSwapsReq.md) - ## Type Aliases -### StoreSwapsRes +### StoreReturnReasonsListRes -Ƭ **StoreSwapsRes**: `Object` +Ƭ **StoreReturnReasonsListRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `swap` | [`Swap`](../classes/internal.Swap.md) | +| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | #### Defined in -medusa/dist/api/routes/store/swaps/index.d.ts:6 +medusa/dist/api/routes/store/return-reasons/index.d.ts:6 + +___ + +### StoreReturnReasonsRes + +Ƭ **StoreReturnReasonsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | + +#### Defined in + +medusa/dist/api/routes/store/return-reasons/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-44.md b/docs/content/references/js-client/modules/internal-44.md new file mode 100644 index 0000000000..363ea60a6a --- /dev/null +++ b/docs/content/references/js-client/modules/internal-44.md @@ -0,0 +1,23 @@ +# Namespace: internal + +## Classes + +- [Item](../classes/internal-44.Item.md) +- [ReturnShipping](../classes/internal-44.ReturnShipping.md) +- [StorePostReturnsReq](../classes/internal-44.StorePostReturnsReq.md) + +## Type Aliases + +### StoreReturnsRes + +Ƭ **StoreReturnsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return` | [`Return`](../classes/internal.Return.md) | + +#### Defined in + +medusa/dist/api/routes/store/returns/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-45.md b/docs/content/references/js-client/modules/internal-45.md new file mode 100644 index 0000000000..199203b89c --- /dev/null +++ b/docs/content/references/js-client/modules/internal-45.md @@ -0,0 +1,21 @@ +# Namespace: internal + +## Classes + +- [StoreGetShippingOptionsParams](../classes/internal-45.StoreGetShippingOptionsParams.md) + +## Type Aliases + +### StoreShippingOptionsListRes + +Ƭ **StoreShippingOptionsListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] | + +#### Defined in + +medusa/dist/api/routes/store/shipping-options/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-46.md b/docs/content/references/js-client/modules/internal-46.md new file mode 100644 index 0000000000..418cfa6373 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-46.md @@ -0,0 +1,23 @@ +# Namespace: internal + +## Classes + +- [AdditionalItem](../classes/internal-46.AdditionalItem.md) +- [Item](../classes/internal-46.Item.md) +- [StorePostSwapsReq](../classes/internal-46.StorePostSwapsReq.md) + +## Type Aliases + +### StoreSwapsRes + +Ƭ **StoreSwapsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `swap` | [`Swap`](../classes/internal.Swap.md) | + +#### Defined in + +medusa/dist/api/routes/store/swaps/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-5.md b/docs/content/references/js-client/modules/internal-5.md index 9420c82978..0252dcab05 100644 --- a/docs/content/references/js-client/modules/internal-5.md +++ b/docs/content/references/js-client/modules/internal-5.md @@ -2,22 +2,51 @@ ## Classes -- [AdminPostCustomersCustomerReq](../classes/internal-5.AdminPostCustomersCustomerReq.md) -- [AdminPostCustomersReq](../classes/internal-5.AdminPostCustomersReq.md) -- [Group](../classes/internal-5.Group.md) +- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) +- [AdminGetCustomerGroupsGroupParams](../classes/internal-5.AdminGetCustomerGroupsGroupParams.md) +- [AdminGetCustomerGroupsParams](../classes/internal-5.AdminGetCustomerGroupsParams.md) +- [AdminGetCustomersParams](../classes/internal-5.AdminGetCustomersParams.md) +- [AdminListCustomerSelector](../classes/internal-5.AdminListCustomerSelector.md) +- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md) +- [AdminPostCustomerGroupsGroupReq](../classes/internal-5.AdminPostCustomerGroupsGroupReq.md) +- [AdminPostCustomerGroupsReq](../classes/internal-5.AdminPostCustomerGroupsReq.md) +- [CustomerGroupsBatchCustomer](../classes/internal-5.CustomerGroupsBatchCustomer.md) +- [FilterableCustomerGroupProps](../classes/internal-5.FilterableCustomerGroupProps.md) +- [FindParams](../classes/internal-5.FindParams.md) +- [StringComparisonOperator](../classes/internal-5.StringComparisonOperator.md) ## Type Aliases -### AdminCustomersRes +### AdminCustomerGroupsListRes -Ƭ **AdminCustomersRes**: `Object` +Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal.CustomerGroup.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/index.d.ts:9 + +___ + +### AdminCustomerGroupsRes + +Ƭ **AdminCustomerGroupsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `customer` | [`Customer`](../classes/internal.Customer.md) | +| `customer_group` | [`CustomerGroup`](../classes/internal.CustomerGroup.md) | #### Defined in -medusa/dist/api/routes/admin/customers/index.d.ts:5 +medusa/dist/api/routes/admin/customer-groups/index.d.ts:5 + +___ + +### AdminCustomersListRes + +Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal.Customer.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/customers/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-6.md b/docs/content/references/js-client/modules/internal-6.md index 05462b8530..81b81169fc 100644 --- a/docs/content/references/js-client/modules/internal-6.md +++ b/docs/content/references/js-client/modules/internal-6.md @@ -2,60 +2,22 @@ ## Classes -- [AdminCreateCondition](../classes/internal-6.AdminCreateCondition.md) -- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md) -- [AdminGetDiscountsDiscountRuleParams](../classes/internal-6.AdminGetDiscountsDiscountRuleParams.md) -- [AdminGetDiscountsParams](../classes/internal-6.AdminGetDiscountsParams.md) -- [AdminPostDiscountsDiscountConditions](../classes/internal-6.AdminPostDiscountsDiscountConditions.md) -- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md) -- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md) -- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md) -- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md) -- [AdminPostDiscountsDiscountReq](../classes/internal-6.AdminPostDiscountsDiscountReq.md) -- [AdminPostDiscountsDiscountRule](../classes/internal-6.AdminPostDiscountsDiscountRule.md) -- [AdminPostDiscountsReq](../classes/internal-6.AdminPostDiscountsReq.md) -- [AdminUpdateDiscountRule](../classes/internal-6.AdminUpdateDiscountRule.md) -- [AdminUpsertCondition](../classes/internal-6.AdminUpsertCondition.md) -- [AdminUpsertConditionsReq](../classes/internal-6.AdminUpsertConditionsReq.md) +- [AdminPostCustomersCustomerReq](../classes/internal-6.AdminPostCustomersCustomerReq.md) +- [AdminPostCustomersReq](../classes/internal-6.AdminPostCustomersReq.md) +- [Group](../classes/internal-6.Group.md) ## Type Aliases -### AdminDiscountConditionsRes +### AdminCustomersRes -Ƭ **AdminDiscountConditionsRes**: `Object` +Ƭ **AdminCustomersRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `discount_condition` | [`DiscountCondition`](../classes/internal.DiscountCondition.md) | +| `customer` | [`Customer`](../classes/internal.Customer.md) | #### Defined in -medusa/dist/api/routes/admin/discounts/index.d.ts:14 - -___ - -### AdminDiscountsListRes - -Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal.Discount.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/discounts/index.d.ts:18 - -___ - -### AdminDiscountsRes - -Ƭ **AdminDiscountsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `discount` | [`Discount`](../classes/internal.Discount.md) | - -#### Defined in - -medusa/dist/api/routes/admin/discounts/index.d.ts:11 +medusa/dist/api/routes/admin/customers/index.d.ts:5 diff --git a/docs/content/references/js-client/modules/internal-7.md b/docs/content/references/js-client/modules/internal-7.md index c89c0e5105..ecddf0e2f3 100644 --- a/docs/content/references/js-client/modules/internal-7.md +++ b/docs/content/references/js-client/modules/internal-7.md @@ -2,50 +2,60 @@ ## Classes -- [AdminGetDraftOrdersParams](../classes/internal-7.AdminGetDraftOrdersParams.md) -- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) -- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md) -- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md) -- [Discount](../classes/internal-7.Discount.md) +- [AdminCreateCondition](../classes/internal-7.AdminCreateCondition.md) +- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md) +- [AdminGetDiscountsDiscountRuleParams](../classes/internal-7.AdminGetDiscountsDiscountRuleParams.md) +- [AdminGetDiscountsParams](../classes/internal-7.AdminGetDiscountsParams.md) +- [AdminPostDiscountsDiscountConditions](../classes/internal-7.AdminPostDiscountsDiscountConditions.md) +- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md) +- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md) +- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md) +- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md) +- [AdminPostDiscountsDiscountReq](../classes/internal-7.AdminPostDiscountsDiscountReq.md) +- [AdminPostDiscountsDiscountRule](../classes/internal-7.AdminPostDiscountsDiscountRule.md) +- [AdminPostDiscountsReq](../classes/internal-7.AdminPostDiscountsReq.md) +- [AdminUpdateDiscountRule](../classes/internal-7.AdminUpdateDiscountRule.md) +- [AdminUpsertCondition](../classes/internal-7.AdminUpsertCondition.md) +- [AdminUpsertConditionsReq](../classes/internal-7.AdminUpsertConditionsReq.md) ## Type Aliases -### AdminDraftOrdersListRes +### AdminDiscountConditionsRes -Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/internal.DraftOrder.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/index.d.ts:18 - -___ - -### AdminDraftOrdersRes - -Ƭ **AdminDraftOrdersRes**: `Object` +Ƭ **AdminDiscountConditionsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `draft_order` | [`DraftOrder`](../classes/internal.DraftOrder.md) | +| `discount_condition` | [`DiscountCondition`](../classes/internal.DiscountCondition.md) | #### Defined in -medusa/dist/api/routes/admin/draft-orders/index.d.ts:14 +medusa/dist/api/routes/admin/discounts/index.d.ts:14 ___ -### AdminPostDraftOrdersDraftOrderRegisterPaymentRes +### AdminDiscountsListRes -Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` +Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal.Discount.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/discounts/index.d.ts:18 + +___ + +### AdminDiscountsRes + +Ƭ **AdminDiscountsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | +| `discount` | [`Discount`](../classes/internal.Discount.md) | #### Defined in -medusa/dist/api/routes/admin/draft-orders/index.d.ts:11 +medusa/dist/api/routes/admin/discounts/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-8.md b/docs/content/references/js-client/modules/internal-8.md index be8bb16104..444c0645ee 100644 --- a/docs/content/references/js-client/modules/internal-8.md +++ b/docs/content/references/js-client/modules/internal-8.md @@ -2,32 +2,50 @@ ## Classes -- [AdminGetGiftCardsParams](../classes/internal-8.AdminGetGiftCardsParams.md) -- [AdminPostGiftCardsGiftCardReq](../classes/internal-8.AdminPostGiftCardsGiftCardReq.md) -- [AdminPostGiftCardsReq](../classes/internal-8.AdminPostGiftCardsReq.md) +- [AdminGetDraftOrdersParams](../classes/internal-8.AdminGetDraftOrdersParams.md) +- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) +- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md) +- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md) +- [Discount](../classes/internal-8.Discount.md) ## Type Aliases -### AdminGiftCardsListRes +### AdminDraftOrdersListRes -Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal.GiftCard.md)[] } +Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/internal.DraftOrder.md)[] } #### Defined in -medusa/dist/api/routes/admin/gift-cards/index.d.ts:14 +medusa/dist/api/routes/admin/draft-orders/index.d.ts:18 ___ -### AdminGiftCardsRes +### AdminDraftOrdersRes -Ƭ **AdminGiftCardsRes**: `Object` +Ƭ **AdminDraftOrdersRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | +| `draft_order` | [`DraftOrder`](../classes/internal.DraftOrder.md) | #### Defined in -medusa/dist/api/routes/admin/gift-cards/index.d.ts:10 +medusa/dist/api/routes/admin/draft-orders/index.d.ts:14 + +___ + +### AdminPostDraftOrdersDraftOrderRegisterPaymentRes + +Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal.Order.md) | + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-9.md b/docs/content/references/js-client/modules/internal-9.md index a20f1c1de3..903fcabfc9 100644 --- a/docs/content/references/js-client/modules/internal-9.md +++ b/docs/content/references/js-client/modules/internal-9.md @@ -2,43 +2,32 @@ ## Classes -- [AdminPostInvitesInviteAcceptReq](../classes/internal-9.AdminPostInvitesInviteAcceptReq.md) -- [AdminPostInvitesInviteAcceptUserReq](../classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md) -- [AdminPostInvitesReq](../classes/internal-9.AdminPostInvitesReq.md) -- [Invite](../classes/internal-9.Invite.md) +- [AdminGetGiftCardsParams](../classes/internal-9.AdminGetGiftCardsParams.md) +- [AdminPostGiftCardsGiftCardReq](../classes/internal-9.AdminPostGiftCardsGiftCardReq.md) +- [AdminPostGiftCardsReq](../classes/internal-9.AdminPostGiftCardsReq.md) ## Type Aliases -### AdminListInvitesRes +### AdminGiftCardsListRes -Ƭ **AdminListInvitesRes**: `Object` +Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal.GiftCard.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/index.d.ts:14 + +___ + +### AdminGiftCardsRes + +Ƭ **AdminGiftCardsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `invites` | [`Invite`](../classes/internal-9.Invite.md)[] | +| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | #### Defined in -medusa/dist/api/routes/admin/invites/index.d.ts:8 - -___ - -### AdminPostInvitesPayload - -Ƭ **AdminPostInvitesPayload**: `Omit`<[`AdminPostInvitesReq`](../classes/internal-9.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-9.md#inviteuserrolesenum) } - -#### Defined in - -[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L47) - -___ - -### InviteUserRolesEnum - -Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` - -#### Defined in - -[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L45) +medusa/dist/api/routes/admin/gift-cards/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal.md b/docs/content/references/js-client/modules/internal.md index c01be29c09..8e312a241d 100644 --- a/docs/content/references/js-client/modules/internal.md +++ b/docs/content/references/js-client/modules/internal.md @@ -17,6 +17,8 @@ displayed_sidebar: jsClientSidebar - [DiscountRuleType](../enums/internal.DiscountRuleType.md) - [DraftOrderStatus](../enums/internal.DraftOrderStatus.md) - [FulfillmentStatus](../enums/internal.FulfillmentStatus.md) +- [OrderEditItemChangeType](../enums/internal.OrderEditItemChangeType.md) +- [OrderEditStatus](../enums/internal.OrderEditStatus.md) - [OrderStatus](../enums/internal.OrderStatus.md) - [PaymentStatus](../enums/internal.PaymentStatus.md) - [PriceListStatus](../enums/internal.PriceListStatus.md) @@ -61,6 +63,8 @@ displayed_sidebar: jsClientSidebar - [LineItemTaxLine](../classes/internal.LineItemTaxLine.md) - [MoneyAmount](../classes/internal.MoneyAmount.md) - [Order](../classes/internal.Order.md) +- [OrderEdit](../classes/internal.OrderEdit.md) +- [OrderItemChange](../classes/internal.OrderItemChange.md) - [Payment](../classes/internal.Payment.md) - [PaymentProvider](../classes/internal.PaymentProvider.md) - [PaymentSession](../classes/internal.PaymentSession.md) @@ -153,7 +157,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L21) +[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L21) ___ @@ -169,7 +173,7 @@ ___ #### Defined in -[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L17) +[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L17) ___ @@ -185,7 +189,7 @@ ___ #### Defined in -[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L21) +[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L21) ___ diff --git a/docs/content/references/services/classes/AuthService.md b/docs/content/references/services/classes/AuthService.md index 3690f566b2..ea403d6560 100644 --- a/docs/content/references/services/classes/AuthService.md +++ b/docs/content/references/services/classes/AuthService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/auth.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L25) +[packages/medusa/src/services/auth.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L24) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/auth.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L23) +[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L22) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L20) +[packages/medusa/src/services/auth.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L19) ___ @@ -92,7 +92,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L21) +[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L20) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L22) +[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L21) ## Methods @@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -169,7 +169,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L98) +[packages/medusa/src/services/auth.ts:97](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L97) ___ @@ -195,7 +195,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L55) +[packages/medusa/src/services/auth.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L54) ___ @@ -223,7 +223,7 @@ success: whether authentication succeeded #### Defined in -[packages/medusa/src/services/auth.ts:147](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L147) +[packages/medusa/src/services/auth.ts:146](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L146) ___ @@ -248,7 +248,7 @@ the result of the comparison #### Defined in -[packages/medusa/src/services/auth.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/auth.ts#L39) +[packages/medusa/src/services/auth.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/auth.ts#L38) ___ @@ -272,7 +272,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -296,4 +296,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/BatchJobService.md b/docs/content/references/services/classes/BatchJobService.md index 6581abff11..ea2e0888ee 100644 --- a/docs/content/references/services/classes/BatchJobService.md +++ b/docs/content/references/services/classes/BatchJobService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L93) +[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L93) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L41) +[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L41) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L45) +[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L45) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L42) +[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L42) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L38) +[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L38) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L43) +[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L43) ___ @@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L39) +[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L39) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L27) +[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L27) ## Methods @@ -182,7 +182,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -202,7 +202,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:274](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L274) +[packages/medusa/src/services/batch-job.ts:269](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L269) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:256](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L256) +[packages/medusa/src/services/batch-job.ts:251](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L251) ___ @@ -242,7 +242,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:238](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L238) +[packages/medusa/src/services/batch-job.ts:233](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L233) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:143](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L143) +[packages/medusa/src/services/batch-job.ts:138](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L138) ___ @@ -283,7 +283,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L132) +[packages/medusa/src/services/batch-job.ts:127](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L127) ___ @@ -304,7 +304,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:371](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L371) +[packages/medusa/src/services/batch-job.ts:366](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L366) ___ @@ -325,7 +325,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:112](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L112) +[packages/medusa/src/services/batch-job.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L107) ___ @@ -346,7 +346,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:345](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L345) +[packages/medusa/src/services/batch-job.ts:340](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L340) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L292) +[packages/medusa/src/services/batch-job.ts:287](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L287) ___ @@ -386,7 +386,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:325](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L325) +[packages/medusa/src/services/batch-job.ts:320](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L320) ___ @@ -410,7 +410,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -431,7 +431,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:162](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L162) +[packages/medusa/src/services/batch-job.ts:157](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L157) ___ @@ -452,7 +452,7 @@ ___ #### Defined in -[packages/medusa/src/services/batch-job.ts:203](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/batch-job.ts#L203) +[packages/medusa/src/services/batch-job.ts:198](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/batch-job.ts#L198) ___ @@ -476,4 +476,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CartService.md b/docs/content/references/services/classes/CartService.md index dae9ff249a..8aa1ddec1c 100644 --- a/docs/content/references/services/classes/CartService.md +++ b/docs/content/references/services/classes/CartService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/cart.ts:122](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L122) +[packages/medusa/src/services/cart.ts:121](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L121) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L99) +[packages/medusa/src/services/cart.ts:98](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L98) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L98) +[packages/medusa/src/services/cart.ts:97](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L97) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L117) +[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L116) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L110) +[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L109) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L112) +[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L111) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:102](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L102) +[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L101) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L120) +[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L119) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L113) +[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L112) ___ @@ -142,17 +142,17 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L116) +[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L115) ___ ### lineItemAdjustmentService\_ -• `Protected` `Readonly` **lineItemAdjustmentService\_**: `LineItemAdjustmentService` +• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md) #### Defined in -[packages/medusa/src/services/cart.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L119) +[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L118) ___ @@ -162,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L101) +[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L100) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L108) +[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L107) ___ @@ -186,7 +186,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/cart.ts:94](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L94) +[packages/medusa/src/services/cart.ts:93](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L93) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L109) +[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L108) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L100) +[packages/medusa/src/services/cart.ts:99](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L99) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L118) +[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L117) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L104) +[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L103) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L103) +[packages/medusa/src/services/cart.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L102) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L107) +[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L106) ___ @@ -256,7 +256,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L106) +[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L105) ___ @@ -266,7 +266,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:97](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L97) +[packages/medusa/src/services/cart.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L96) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L111) +[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L110) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L105) +[packages/medusa/src/services/cart.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L104) ___ @@ -296,7 +296,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L114) +[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L113) ___ @@ -306,7 +306,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L115) +[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L114) ___ @@ -320,7 +320,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/cart.ts:95](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L95) +[packages/medusa/src/services/cart.ts:94](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L94) ___ @@ -338,7 +338,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L88) +[packages/medusa/src/services/cart.ts:87](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L87) ## Methods @@ -365,7 +365,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:614](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L614) +[packages/medusa/src/services/cart.ts:667](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L667) ___ @@ -395,7 +395,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1697](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1697) +[packages/medusa/src/services/cart.ts:1735](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1735) ___ @@ -423,7 +423,7 @@ void #### Defined in -[packages/medusa/src/services/cart.ts:781](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L781) +[packages/medusa/src/services/cart.ts:834](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L834) ___ @@ -451,7 +451,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1207](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1207) +[packages/medusa/src/services/cart.ts:1260](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1260) ___ @@ -472,7 +472,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:1171](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1171) +[packages/medusa/src/services/cart.ts:1224](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1224) ___ @@ -511,7 +511,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -540,7 +540,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1353](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1353) +[packages/medusa/src/services/cart.ts:1406](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1406) ___ @@ -564,7 +564,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/cart.ts:351](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L351) +[packages/medusa/src/services/cart.ts:404](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L404) ___ @@ -588,7 +588,7 @@ the resultign customer object #### Defined in -[packages/medusa/src/services/cart.ts:1056](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1056) +[packages/medusa/src/services/cart.ts:1109](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1109) ___ @@ -608,7 +608,28 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2105) +[packages/medusa/src/services/cart.ts:2142](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2142) + +___ + +### decorateTotals + +▸ **decorateTotals**(`cart`, `totalsConfig?`): `Promise`<`Cart`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | `Cart` | +| `totalsConfig?` | `TotalsConfig` | + +#### Returns + +`Promise`<`Cart`\> + +#### Defined in + +[packages/medusa/src/services/cart.ts:2192](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2192) ___ @@ -630,7 +651,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:230](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L230) +[packages/medusa/src/services/cart.ts:247](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L247) ___ @@ -654,7 +675,7 @@ the deleted cart or undefined if the cart was not found. #### Defined in -[packages/medusa/src/services/cart.ts:2018](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2018) +[packages/medusa/src/services/cart.ts:2057](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2057) ___ @@ -679,7 +700,7 @@ the resulting cart. #### Defined in -[packages/medusa/src/services/cart.ts:1605](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1605) +[packages/medusa/src/services/cart.ts:1643](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1643) ___ @@ -699,7 +720,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2136](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2136) +[packages/medusa/src/services/cart.ts:2173](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2173) ___ @@ -725,7 +746,27 @@ custom shipping option #### Defined in -[packages/medusa/src/services/cart.ts:1805](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1805) +[packages/medusa/src/services/cart.ts:1843](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1843) + +___ + +### getTotalsRelations + +▸ `Private` **getTotalsRelations**(`config`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `FindConfig`<`Cart`\> | + +#### Returns + +`string`[] + +#### Defined in + +[packages/medusa/src/services/cart.ts:178](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L178) ___ @@ -745,7 +786,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:454](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L454) +[packages/medusa/src/services/cart.ts:507](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L507) ___ @@ -768,7 +809,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/cart.ts:286](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L286) +[packages/medusa/src/services/cart.ts:303](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L303) ___ @@ -793,7 +834,7 @@ void #### Defined in -[packages/medusa/src/services/cart.ts:1002](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1002) +[packages/medusa/src/services/cart.ts:1055](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1055) ___ @@ -813,7 +854,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:2155](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2155) +[packages/medusa/src/services/cart.ts:2263](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2263) ___ @@ -838,7 +879,7 @@ the resulting cart. #### Defined in -[packages/medusa/src/services/cart.ts:1653](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1653) +[packages/medusa/src/services/cart.ts:1691](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1691) ___ @@ -863,7 +904,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1267](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1267) +[packages/medusa/src/services/cart.ts:1320](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1320) ___ @@ -888,7 +929,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:486](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L486) +[packages/medusa/src/services/cart.ts:539](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L539) ___ @@ -904,7 +945,7 @@ Gets a cart by id. | :------ | :------ | :------ | | `cartId` | `string` | the id of the cart to get. | | `options` | `FindConfig`<`Cart`\> | the options to get a cart | -| `totalsConfig` | `TotalsConfig` | configuration for retrieval of totals | +| `totalsConfig` | `TotalsConfig` | - | #### Returns @@ -914,7 +955,50 @@ the cart document. #### Defined in -[packages/medusa/src/services/cart.ts:304](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L304) +[packages/medusa/src/services/cart.ts:320](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L320) + +___ + +### retrieveNew + +▸ `Private` **retrieveNew**(`cartId`, `options?`): `Promise`<`Cart`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartId` | `string` | +| `options` | `FindConfig`<`Cart`\> | + +#### Returns + +`Promise`<`Cart`\> + +#### Defined in + +[packages/medusa/src/services/cart.ts:356](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L356) + +___ + +### retrieveWithTotals + +▸ **retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<`Cart`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartId` | `string` | +| `options` | `FindConfig`<`Cart`\> | +| `totalsConfig` | `TotalsConfig` | + +#### Returns + +`Promise`<`Cart`\> + +#### Defined in + +[packages/medusa/src/services/cart.ts:384](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L384) ___ @@ -942,7 +1026,7 @@ resolves to the updated result. #### Defined in -[packages/medusa/src/services/cart.ts:2061](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L2061) +[packages/medusa/src/services/cart.ts:2100](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L2100) ___ @@ -967,7 +1051,7 @@ result of update operation #### Defined in -[packages/medusa/src/services/cart.ts:1424](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1424) +[packages/medusa/src/services/cart.ts:1477](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1477) ___ @@ -995,7 +1079,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/cart.ts:1497](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1497) +[packages/medusa/src/services/cart.ts:1543](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1543) ___ @@ -1021,7 +1105,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1884](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1884) +[packages/medusa/src/services/cart.ts:1923](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1923) ___ @@ -1045,7 +1129,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -1065,7 +1149,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L179) +[packages/medusa/src/services/cart.ts:196](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L196) ___ @@ -1086,7 +1170,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:824](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L824) +[packages/medusa/src/services/cart.ts:877](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L877) ___ @@ -1112,7 +1196,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1082](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1082) +[packages/medusa/src/services/cart.ts:1135](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1135) ___ @@ -1137,7 +1221,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1038](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1038) +[packages/medusa/src/services/cart.ts:1091](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1091) ___ @@ -1163,7 +1247,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:716](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L716) +[packages/medusa/src/services/cart.ts:769](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L769) ___ @@ -1188,7 +1272,7 @@ the resulting cart #### Defined in -[packages/medusa/src/services/cart.ts:1315](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1315) +[packages/medusa/src/services/cart.ts:1368](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1368) ___ @@ -1214,7 +1298,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/cart.ts:1122](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1122) +[packages/medusa/src/services/cart.ts:1175](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1175) ___ @@ -1236,7 +1320,7 @@ ___ #### Defined in -[packages/medusa/src/services/cart.ts:1824](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L1824) +[packages/medusa/src/services/cart.ts:1862](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L1862) ___ @@ -1261,7 +1345,7 @@ a boolean indicating validation result #### Defined in -[packages/medusa/src/services/cart.ts:583](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L583) +[packages/medusa/src/services/cart.ts:636](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L636) ___ @@ -1288,7 +1372,7 @@ boolean representing whether shipping method is validated #### Defined in -[packages/medusa/src/services/cart.ts:552](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/cart.ts#L552) +[packages/medusa/src/services/cart.ts:605](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/cart.ts#L605) ___ @@ -1312,4 +1396,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ClaimItemService.md b/docs/content/references/services/classes/ClaimItemService.md index 09072a7b4b..fbaa32805a 100644 --- a/docs/content/references/services/classes/ClaimItemService.md +++ b/docs/content/references/services/classes/ClaimItemService.md @@ -20,11 +20,11 @@ #### Overrides -BaseService.constructor +TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L30) +[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L30) ## Properties @@ -34,11 +34,11 @@ BaseService.constructor #### Inherited from -BaseService.\_\_configModule\_\_ +TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -48,11 +48,11 @@ ___ #### Inherited from -BaseService.\_\_container\_\_ +TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L25) +[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L25) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L23) +[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L23) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L24) +[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L24) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L22) +[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L22) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L21) +[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L21) ___ @@ -112,11 +112,11 @@ ___ #### Overrides -BaseService.manager\_ +TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L27) +[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L27) ___ @@ -126,11 +126,11 @@ ___ #### Overrides -BaseService.transactionManager\_ +TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L28) +[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L28) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L15) +[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L15) ## Methods @@ -183,11 +183,11 @@ the result of the transactional work #### Inherited from -BaseService.atomicPhase\_ +TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -207,7 +207,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L49) +[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L49) ___ @@ -230,7 +230,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L214) +[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L214) ___ @@ -255,7 +255,7 @@ the ClaimItem #### Defined in -[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L233) +[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L233) ___ @@ -275,11 +275,11 @@ ___ #### Inherited from -BaseService.shouldRetryTransaction\_ +TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim-item.ts#L132) +[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim-item.ts#L132) ___ @@ -320,8 +320,8 @@ ___ #### Inherited from -BaseService.withTransaction +TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ClaimService.md b/docs/content/references/services/classes/ClaimService.md index 43531a29fb..d1d27fdbe7 100644 --- a/docs/content/references/services/classes/ClaimService.md +++ b/docs/content/references/services/classes/ClaimService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L83) +[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L83) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L66) +[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L66) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L70) +[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L70) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L67) +[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L67) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L71) +[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L71) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L72) +[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L72) ___ @@ -112,7 +112,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L73) +[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L73) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L74) +[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L74) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L69) +[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L69) ___ @@ -142,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L75) +[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L75) ___ @@ -156,7 +156,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L63) +[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L63) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L76) +[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L76) ___ @@ -176,7 +176,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L77) +[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L77) ___ @@ -186,7 +186,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L78) +[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L78) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L68) +[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L68) ___ @@ -206,7 +206,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L79) +[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L79) ___ @@ -216,7 +216,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L80) +[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L80) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L81) +[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L81) ___ @@ -240,7 +240,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L64) +[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L64) ___ @@ -261,7 +261,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L54) +[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L54) ## Methods @@ -300,7 +300,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -320,7 +320,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:761](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L761) +[packages/medusa/src/services/claim.ts:761](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L761) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:609](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L609) +[packages/medusa/src/services/claim.ts:609](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L609) ___ @@ -366,7 +366,7 @@ created claim #### Defined in -[packages/medusa/src/services/claim.ts:213](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L213) +[packages/medusa/src/services/claim.ts:213](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L213) ___ @@ -391,7 +391,7 @@ created claim #### Defined in -[packages/medusa/src/services/claim.ts:463](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L463) +[packages/medusa/src/services/claim.ts:463](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L463) ___ @@ -416,7 +416,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:681](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L681) +[packages/medusa/src/services/claim.ts:681](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L681) ___ @@ -439,7 +439,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/claim.ts:817](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L817) +[packages/medusa/src/services/claim.ts:817](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L817) ___ @@ -459,7 +459,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:635](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L635) +[packages/medusa/src/services/claim.ts:635](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L635) ___ @@ -484,7 +484,7 @@ the order document #### Defined in -[packages/medusa/src/services/claim.ts:837](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L837) +[packages/medusa/src/services/claim.ts:837](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L837) ___ @@ -508,7 +508,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -529,7 +529,7 @@ ___ #### Defined in -[packages/medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/claim.ts#L125) +[packages/medusa/src/services/claim.ts:125](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/claim.ts#L125) ___ @@ -553,4 +553,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CurrencyService.md b/docs/content/references/services/classes/CurrencyService.md index 1f3157020b..048be07a67 100644 --- a/docs/content/references/services/classes/CurrencyService.md +++ b/docs/content/references/services/classes/CurrencyService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L32) +[packages/medusa/src/services/currency.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L32) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L28) +[packages/medusa/src/services/currency.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L28) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L29) +[packages/medusa/src/services/currency.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L29) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L30) +[packages/medusa/src/services/currency.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L30) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L25) +[packages/medusa/src/services/currency.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L25) ___ @@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L26) +[packages/medusa/src/services/currency.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L26) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L21) +[packages/medusa/src/services/currency.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L21) ## Methods @@ -165,7 +165,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -193,7 +193,7 @@ an array containing the currencies as #### Defined in -[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L81) +[packages/medusa/src/services/currency.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L81) ___ @@ -217,7 +217,7 @@ The currency #### Defined in -[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L50) +[packages/medusa/src/services/currency.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L50) ___ @@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -266,7 +266,7 @@ The updated currency #### Defined in -[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/currency.ts#L103) +[packages/medusa/src/services/currency.ts:103](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/currency.ts#L103) ___ @@ -290,4 +290,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CustomShippingOptionService.md b/docs/content/references/services/classes/CustomShippingOptionService.md index c5c684f443..8b5b20fce0 100644 --- a/docs/content/references/services/classes/CustomShippingOptionService.md +++ b/docs/content/references/services/classes/CustomShippingOptionService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L19) +[packages/medusa/src/services/custom-shipping-option.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L20) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L17) +[packages/medusa/src/services/custom-shipping-option.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L18) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L15) +[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L15) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L16) +[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L16) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -153,7 +153,7 @@ resolves to the creation result #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L88) +[packages/medusa/src/services/custom-shipping-option.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L89) ___ @@ -178,7 +178,7 @@ custom shipping options matching the query #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L64) +[packages/medusa/src/services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L65) ___ @@ -203,7 +203,7 @@ the requested custom shipping option. #### Defined in -[packages/medusa/src/services/custom-shipping-option.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/custom-shipping-option.ts#L36) +[packages/medusa/src/services/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/custom-shipping-option.ts#L37) ___ @@ -227,7 +227,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -251,4 +251,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CustomerGroupService.md b/docs/content/references/services/classes/CustomerGroupService.md index f31db71019..6e94780364 100644 --- a/docs/content/references/services/classes/CustomerGroupService.md +++ b/docs/content/references/services/classes/CustomerGroupService.md @@ -1,12 +1,8 @@ # Class: CustomerGroupService -Provides layer to manipulate discounts. - -**`Implements`** - ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService` ↳ **`CustomerGroupService`** @@ -24,41 +20,87 @@ Provides layer to manipulate discounts. #### Overrides -BaseService.constructor +TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/customer-group.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L32) +[packages/medusa/src/services/customer-group.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L33) ## Properties -### customerGroupRepository\_ +### \_\_configModule\_\_ -• `Private` **customerGroupRepository\_**: typeof `CustomerGroupRepository` +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/services/customer-group.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L28) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### customerGroupRepository\_ + +• `Protected` `Readonly` **customerGroupRepository\_**: typeof `CustomerGroupRepository` + +#### Defined in + +[packages/medusa/src/services/customer-group.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L30) ___ ### customerService\_ -• `Private` **customerService\_**: [`CustomerService`](CustomerService.md) +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](CustomerService.md) #### Defined in -[packages/medusa/src/services/customer-group.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L30) +[packages/medusa/src/services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L31) ___ ### manager\_ -• `Private` **manager\_**: `EntityManager` +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/customer-group.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L26) +[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L27) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/customer-group.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L28) ## Methods @@ -83,7 +125,46 @@ the customer group after insertion #### Defined in -[packages/medusa/src/services/customer-group.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L114) +[packages/medusa/src/services/customer-group.ts:92](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L92) + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -115,7 +196,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/customer-group.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L87) +[packages/medusa/src/services/customer-group.ts:68](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L68) ___ @@ -139,7 +220,7 @@ a promise #### Defined in -[packages/medusa/src/services/customer-group.ts:195](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L195) +[packages/medusa/src/services/customer-group.ts:174](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L174) ___ @@ -164,7 +245,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer-group.ts:218](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L218) +[packages/medusa/src/services/customer-group.ts:197](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L197) ___ @@ -189,7 +270,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer-group.ts:237](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L237) +[packages/medusa/src/services/customer-group.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L216) ___ @@ -214,7 +295,7 @@ the customergroup with the provided id #### Defined in -[packages/medusa/src/services/customer-group.ts:272](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L272) +[packages/medusa/src/services/customer-group.ts:252](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L252) ___ @@ -235,13 +316,37 @@ ___ #### Defined in -[packages/medusa/src/services/customer-group.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L63) +[packages/medusa/src/services/customer-group.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L45) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ ### update -▸ **update**(`customerGroupId`, `update`): `Promise`<`CustomerGroup`[]\> +▸ **update**(`customerGroupId`, `update`): `Promise`<`CustomerGroup`\> Update a customer group. @@ -254,30 +359,34 @@ Update a customer group. #### Returns -`Promise`<`CustomerGroup`[]\> +`Promise`<`CustomerGroup`\> resulting customer group #### Defined in -[packages/medusa/src/services/customer-group.ts:163](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L163) +[packages/medusa/src/services/customer-group.ts:141](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer-group.ts#L141) ___ ### withTransaction -▸ **withTransaction**(`transactionManager`): [`CustomerGroupService`](CustomerGroupService.md) +▸ **withTransaction**(`transactionManager?`): [`CustomerGroupService`](CustomerGroupService.md) #### Parameters | Name | Type | | :------ | :------ | -| `transactionManager` | `EntityManager` | +| `transactionManager?` | `EntityManager` | #### Returns [`CustomerGroupService`](CustomerGroupService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[packages/medusa/src/services/customer-group.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer-group.ts#L47) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/CustomerService.md b/docs/content/references/services/classes/CustomerService.md index b57692b795..74557acd1e 100644 --- a/docs/content/references/services/classes/CustomerService.md +++ b/docs/content/references/services/classes/CustomerService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L39) +[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L39) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L27) +[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L27) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L26) +[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L26) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L28) +[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L28) ___ @@ -98,7 +98,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L30) +[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L30) ___ @@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L31) +[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L31) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L33) +[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L33) ## Methods @@ -151,7 +151,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:461](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L461) +[packages/medusa/src/services/customer.ts:461](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L461) ___ @@ -190,7 +190,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -208,7 +208,7 @@ the result of the count operation #### Defined in -[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L158) +[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L158) ___ @@ -235,7 +235,7 @@ the result of create #### Defined in -[packages/medusa/src/services/customer.ts:245](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L245) +[packages/medusa/src/services/customer.ts:245](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L245) ___ @@ -259,7 +259,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/customer.ts:509](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L509) +[packages/medusa/src/services/customer.ts:509](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L509) ___ @@ -287,7 +287,7 @@ the generated JSON web token #### Defined in -[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L64) +[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L64) ___ @@ -311,7 +311,7 @@ hashed password #### Defined in -[packages/medusa/src/services/customer.ts:232](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L232) +[packages/medusa/src/services/customer.ts:232](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L232) ___ @@ -334,7 +334,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L107) +[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L107) ___ @@ -357,7 +357,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L131) +[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L131) ___ @@ -378,7 +378,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:444](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L444) +[packages/medusa/src/services/customer.ts:444](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L444) ___ @@ -403,7 +403,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:220](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L220) +[packages/medusa/src/services/customer.ts:220](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L220) ___ @@ -428,7 +428,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:194](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L194) +[packages/medusa/src/services/customer.ts:194](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L194) ___ @@ -453,7 +453,7 @@ the customer document. #### Defined in -[packages/medusa/src/services/customer.ts:207](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L207) +[packages/medusa/src/services/customer.ts:207](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L207) ___ @@ -474,7 +474,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L164) +[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L164) ___ @@ -498,7 +498,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -523,7 +523,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/customer.ts:300](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L300) +[packages/medusa/src/services/customer.ts:300](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L300) ___ @@ -545,7 +545,7 @@ ___ #### Defined in -[packages/medusa/src/services/customer.ts:416](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L416) +[packages/medusa/src/services/customer.ts:416](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L416) ___ @@ -570,7 +570,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/customer.ts:364](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/customer.ts#L364) +[packages/medusa/src/services/customer.ts:364](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/customer.ts#L364) ___ @@ -594,4 +594,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/DiscountService.md b/docs/content/references/services/classes/DiscountService.md index 3f06532060..7840694882 100644 --- a/docs/content/references/services/classes/DiscountService.md +++ b/docs/content/references/services/classes/DiscountService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L65) +[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L66) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L54) +[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L54) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L57) +[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L58) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L58) +[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L59) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L53) +[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L53) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L55) +[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L55) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L62) +[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L63) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L63) +[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L64) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L56) +[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L56) ___ @@ -150,7 +150,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/discount.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L50) +[packages/medusa/src/services/discount.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L50) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L60) +[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L61) ___ @@ -170,7 +170,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L61) +[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L62) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L59) +[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L60) ___ @@ -194,7 +194,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L51) +[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L51) ## Methods @@ -219,7 +219,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:470](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L470) +[packages/medusa/src/services/discount.ts:473](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L473) ___ @@ -258,7 +258,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:571](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L571) +[packages/medusa/src/services/discount.ts:574](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L574) ___ @@ -301,7 +301,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:730](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L730) +[packages/medusa/src/services/discount.ts:733](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L733) ___ @@ -326,7 +326,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/discount.ts:181](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L181) +[packages/medusa/src/services/discount.ts:182](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L182) ___ @@ -351,7 +351,7 @@ the newly created dynamic code #### Defined in -[packages/medusa/src/services/discount.ts:398](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L398) +[packages/medusa/src/services/discount.ts:401](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L401) ___ @@ -375,7 +375,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/discount.ts:530](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L530) +[packages/medusa/src/services/discount.ts:533](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L533) ___ @@ -400,7 +400,7 @@ the newly created dynamic code #### Defined in -[packages/medusa/src/services/discount.ts:449](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L449) +[packages/medusa/src/services/discount.ts:452](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L452) ___ @@ -420,7 +420,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:699](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L699) +[packages/medusa/src/services/discount.ts:702](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L702) ___ @@ -440,7 +440,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:695](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L695) +[packages/medusa/src/services/discount.ts:698](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L698) ___ @@ -460,7 +460,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:689](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L689) +[packages/medusa/src/services/discount.ts:692](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L692) ___ @@ -480,7 +480,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:707](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L707) +[packages/medusa/src/services/discount.ts:710](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L710) ___ @@ -501,7 +501,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:711](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L711) +[packages/medusa/src/services/discount.ts:714](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L714) ___ @@ -524,7 +524,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/discount.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L119) +[packages/medusa/src/services/discount.ts:120](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L120) ___ @@ -547,7 +547,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/discount.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L135) +[packages/medusa/src/services/discount.ts:136](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L136) ___ @@ -572,7 +572,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:505](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L505) +[packages/medusa/src/services/discount.ts:508](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L508) ___ @@ -597,7 +597,7 @@ the discount #### Defined in -[packages/medusa/src/services/discount.ts:246](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L246) +[packages/medusa/src/services/discount.ts:245](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L245) ___ @@ -622,7 +622,7 @@ the discount document #### Defined in -[packages/medusa/src/services/discount.ts:272](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L272) +[packages/medusa/src/services/discount.ts:271](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L271) ___ @@ -646,7 +646,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -671,7 +671,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/discount.ts:303](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L303) +[packages/medusa/src/services/discount.ts:304](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L304) ___ @@ -692,7 +692,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:629](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L629) +[packages/medusa/src/services/discount.ts:632](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L632) ___ @@ -713,7 +713,7 @@ ___ #### Defined in -[packages/medusa/src/services/discount.ts:544](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L544) +[packages/medusa/src/services/discount.ts:547](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L547) ___ @@ -743,7 +743,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/discount.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/discount.ts#L101) +[packages/medusa/src/services/discount.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/discount.ts#L102) ___ @@ -767,4 +767,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/DraftOrderService.md b/docs/content/references/services/classes/DraftOrderService.md index 5726c88076..b9d5cd7c90 100644 --- a/docs/content/references/services/classes/DraftOrderService.md +++ b/docs/content/references/services/classes/DraftOrderService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L51) +[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L51) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L46) +[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L46) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L42) +[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L42) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L45) +[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L45) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L47) +[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L47) ___ @@ -110,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L39) +[packages/medusa/src/services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L39) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L44) +[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L44) ___ @@ -130,7 +130,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L43) +[packages/medusa/src/services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L43) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L48) +[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L48) ___ @@ -150,7 +150,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L49) +[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L49) ___ @@ -164,7 +164,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L40) +[packages/medusa/src/services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L40) ___ @@ -181,7 +181,7 @@ ___ #### Defined in -[packages/medusa/src/services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L34) +[packages/medusa/src/services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L34) ## Methods @@ -220,7 +220,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -244,7 +244,7 @@ the created draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:245](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L245) +[packages/medusa/src/services/draft-order.ts:235](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L235) ___ @@ -268,7 +268,7 @@ empty promise #### Defined in -[packages/medusa/src/services/draft-order.ts:144](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L144) +[packages/medusa/src/services/draft-order.ts:134](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L134) ___ @@ -293,7 +293,7 @@ list of draft orders #### Defined in -[packages/medusa/src/services/draft-order.ts:222](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L222) +[packages/medusa/src/services/draft-order.ts:212](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L212) ___ @@ -318,7 +318,7 @@ draft orders #### Defined in -[packages/medusa/src/services/draft-order.ts:168](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L168) +[packages/medusa/src/services/draft-order.ts:158](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L158) ___ @@ -343,7 +343,7 @@ the created order #### Defined in -[packages/medusa/src/services/draft-order.ts:357](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L357) +[packages/medusa/src/services/draft-order.ts:347](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L347) ___ @@ -368,7 +368,7 @@ the draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L91) +[packages/medusa/src/services/draft-order.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L81) ___ @@ -393,7 +393,7 @@ the draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L118) +[packages/medusa/src/services/draft-order.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L108) ___ @@ -417,7 +417,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -443,7 +443,7 @@ the updated draft order #### Defined in -[packages/medusa/src/services/draft-order.ts:386](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/draft-order.ts#L386) +[packages/medusa/src/services/draft-order.ts:376](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/draft-order.ts#L376) ___ @@ -467,4 +467,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/EventBusService.md b/docs/content/references/services/classes/EventBusService.md index 4e12b856da..6f8226503d 100644 --- a/docs/content/references/services/classes/EventBusService.md +++ b/docs/content/references/services/classes/EventBusService.md @@ -19,7 +19,7 @@ subscribers when events happen. Events will run asynchronously. #### Defined in -[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L38) +[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L38) ## Properties @@ -29,7 +29,7 @@ subscribers when events happen. Events will run asynchronously. #### Defined in -[packages/medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L24) +[packages/medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L24) ___ @@ -39,7 +39,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L29) +[packages/medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L29) ___ @@ -49,7 +49,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L32) +[packages/medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L32) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L36) +[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L36) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L26) +[packages/medusa/src/services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L26) ___ @@ -79,7 +79,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L25) +[packages/medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L25) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L28) +[packages/medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L28) ___ @@ -99,7 +99,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L33) +[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L33) ___ @@ -109,7 +109,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L30) +[packages/medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L30) ___ @@ -119,7 +119,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L31) +[packages/medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L31) ___ @@ -129,7 +129,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L34) +[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L34) ___ @@ -139,7 +139,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L27) +[packages/medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L27) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L35) +[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L35) ## Methods @@ -182,7 +182,7 @@ void #### Defined in -[packages/medusa/src/services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L308) +[packages/medusa/src/services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L308) ___ @@ -215,7 +215,7 @@ resolves to the results of the subscriber calls. #### Defined in -[packages/medusa/src/services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L281) +[packages/medusa/src/services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L281) ___ @@ -248,7 +248,7 @@ the job from our queue #### Defined in -[packages/medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L179) +[packages/medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L179) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L215) +[packages/medusa/src/services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L215) ___ @@ -287,7 +287,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L158) +[packages/medusa/src/services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L158) ___ @@ -301,7 +301,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L205) +[packages/medusa/src/services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L205) ___ @@ -315,7 +315,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L210) +[packages/medusa/src/services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L210) ___ @@ -340,7 +340,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L118) +[packages/medusa/src/services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L118) ___ @@ -365,7 +365,7 @@ this #### Defined in -[packages/medusa/src/services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L136) +[packages/medusa/src/services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L136) ___ @@ -385,7 +385,7 @@ ___ #### Defined in -[packages/medusa/src/services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L88) +[packages/medusa/src/services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L88) ___ @@ -418,4 +418,4 @@ resolves to the results of the subscriber calls. #### Defined in -[packages/medusa/src/services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/event-bus.ts#L250) +[packages/medusa/src/services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/event-bus.ts#L250) diff --git a/docs/content/references/services/classes/FulfillmentProviderService.md b/docs/content/references/services/classes/FulfillmentProviderService.md index 4d08a114ec..2ecf6f864f 100644 --- a/docs/content/references/services/classes/FulfillmentProviderService.md +++ b/docs/content/references/services/classes/FulfillmentProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L43) +[packages/medusa/src/services/fulfillment-provider.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L43) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L39) +[packages/medusa/src/services/fulfillment-provider.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L39) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L41) +[packages/medusa/src/services/fulfillment-provider.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L41) ___ @@ -88,7 +88,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L36) +[packages/medusa/src/services/fulfillment-provider.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L36) ___ @@ -102,7 +102,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L37) +[packages/medusa/src/services/fulfillment-provider.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L37) ## Methods @@ -141,7 +141,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:148](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L148) +[packages/medusa/src/services/fulfillment-provider.ts:147](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L147) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:123](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L123) +[packages/medusa/src/services/fulfillment-provider.ts:122](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L122) ___ @@ -203,7 +203,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:141](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L141) +[packages/medusa/src/services/fulfillment-provider.ts:140](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L140) ___ @@ -226,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L108) +[packages/medusa/src/services/fulfillment-provider.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L107) ___ @@ -246,7 +246,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:162](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L162) +[packages/medusa/src/services/fulfillment-provider.ts:161](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L161) ___ @@ -260,7 +260,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L67) +[packages/medusa/src/services/fulfillment-provider.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L67) ___ @@ -280,7 +280,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L75) +[packages/medusa/src/services/fulfillment-provider.ts:75](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L75) ___ @@ -300,7 +300,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L53) +[packages/medusa/src/services/fulfillment-provider.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L53) ___ @@ -326,13 +326,13 @@ document to fetch #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:181](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L181) +[packages/medusa/src/services/fulfillment-provider.ts:180](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L180) ___ ### retrieveProvider -▸ **retrieveProvider**(`providerId`): `BaseFulfillmentService` +▸ **retrieveProvider**(`providerId`): `any` #### Parameters @@ -342,13 +342,13 @@ ___ #### Returns -`BaseFulfillmentService` +`any` the payment fulfillment provider #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:97](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L97) +[packages/medusa/src/services/fulfillment-provider.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L96) ___ @@ -372,7 +372,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:128](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L128) +[packages/medusa/src/services/fulfillment-provider.ts:127](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L127) ___ @@ -414,7 +414,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment-provider.ts:157](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment-provider.ts#L157) +[packages/medusa/src/services/fulfillment-provider.ts:156](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment-provider.ts#L156) ___ @@ -438,4 +438,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/FulfillmentService.md b/docs/content/references/services/classes/FulfillmentService.md index 3e1a79a383..6ffb661b3c 100644 --- a/docs/content/references/services/classes/FulfillmentService.md +++ b/docs/content/references/services/classes/FulfillmentService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L47) +[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L42) +[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L42) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L43) +[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L43) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L45) +[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L45) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L40) +[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L40) ___ @@ -108,7 +108,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L36) +[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L36) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L41) +[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L41) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L39) +[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L39) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L44) +[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L44) ___ @@ -152,7 +152,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L37) +[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L37) ## Methods @@ -191,7 +191,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -217,7 +217,7 @@ the result of the save operation #### Defined in -[packages/medusa/src/services/fulfillment.ts:253](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L253) +[packages/medusa/src/services/fulfillment.ts:253](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L253) ___ @@ -246,7 +246,7 @@ the created fulfillments #### Defined in -[packages/medusa/src/services/fulfillment.ts:198](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L198) +[packages/medusa/src/services/fulfillment.ts:198](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L198) ___ @@ -273,7 +273,7 @@ the shipped fulfillment #### Defined in -[packages/medusa/src/services/fulfillment.ts:303](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L303) +[packages/medusa/src/services/fulfillment.ts:303](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L303) ___ @@ -298,7 +298,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L109) +[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L109) ___ @@ -319,7 +319,7 @@ ___ #### Defined in -[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L71) +[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L71) ___ @@ -344,7 +344,7 @@ the fulfillment #### Defined in -[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L166) +[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L166) ___ @@ -368,7 +368,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -397,7 +397,7 @@ a line item that has the requested fulfillment quantity #### Defined in -[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/fulfillment.ts#L134) +[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/fulfillment.ts#L134) ___ @@ -421,4 +421,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/GiftCardService.md b/docs/content/references/services/classes/GiftCardService.md index 83ffd6a526..5bc0effadd 100644 --- a/docs/content/references/services/classes/GiftCardService.md +++ b/docs/content/references/services/classes/GiftCardService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/gift-card.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L46) +[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L47) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L37) +[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L38) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L34) +[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L34) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L35) +[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L36) ___ @@ -98,7 +98,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L39) +[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L40) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L36) +[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L37) ___ @@ -122,7 +122,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L40) +[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L41) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L42) +[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L43) ## Methods @@ -177,7 +177,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -201,7 +201,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/gift-card.ts:152](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L152) +[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L153) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:137](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L137) +[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L138) ___ @@ -245,7 +245,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/gift-card.ts:282](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L282) +[packages/medusa/src/services/gift-card.ts:283](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L283) ___ @@ -268,7 +268,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/gift-card.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L113) +[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L114) ___ @@ -291,7 +291,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/gift-card.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L84) +[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L85) ___ @@ -316,7 +316,7 @@ the gift card #### Defined in -[packages/medusa/src/services/gift-card.ts:216](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L216) +[packages/medusa/src/services/gift-card.ts:217](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L217) ___ @@ -337,7 +337,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:223](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L223) +[packages/medusa/src/services/gift-card.ts:224](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L224) ___ @@ -358,7 +358,7 @@ ___ #### Defined in -[packages/medusa/src/services/gift-card.ts:182](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L182) +[packages/medusa/src/services/gift-card.ts:183](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L183) ___ @@ -382,7 +382,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -407,7 +407,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/gift-card.ts:236](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L236) +[packages/medusa/src/services/gift-card.ts:237](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L237) ___ @@ -431,7 +431,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) ___ @@ -449,4 +449,4 @@ the generated gift card code #### Defined in -[packages/medusa/src/services/gift-card.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/gift-card.ts#L68) +[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/gift-card.ts#L69) diff --git a/docs/content/references/services/classes/IdempotencyKeyService.md b/docs/content/references/services/classes/IdempotencyKeyService.md index 8c3d2f9b47..4fb9ca1ea4 100644 --- a/docs/content/references/services/classes/IdempotencyKeyService.md +++ b/docs/content/references/services/classes/IdempotencyKeyService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/idempotency-key.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L22) +[packages/medusa/src/services/idempotency-key.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L22) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L20) +[packages/medusa/src/services/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L20) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L17) +[packages/medusa/src/services/idempotency-key.ts:17](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L17) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/idempotency-key.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L18) +[packages/medusa/src/services/idempotency-key.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L18) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -155,7 +155,7 @@ the created idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L64) +[packages/medusa/src/services/idempotency-key.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L64) ___ @@ -182,7 +182,7 @@ the existing or created idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L38) +[packages/medusa/src/services/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L38) ___ @@ -206,7 +206,7 @@ result of the update operation #### Defined in -[packages/medusa/src/services/idempotency-key.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L106) +[packages/medusa/src/services/idempotency-key.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L106) ___ @@ -230,7 +230,7 @@ idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L82) +[packages/medusa/src/services/idempotency-key.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L82) ___ @@ -254,7 +254,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -289,7 +289,7 @@ result of the update operation #### Defined in -[packages/medusa/src/services/idempotency-key.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L135) +[packages/medusa/src/services/idempotency-key.ts:135](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L135) ___ @@ -313,7 +313,7 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) ___ @@ -342,4 +342,4 @@ new updated idempotency key #### Defined in -[packages/medusa/src/services/idempotency-key.ts:164](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/idempotency-key.ts#L164) +[packages/medusa/src/services/idempotency-key.ts:164](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/idempotency-key.ts#L164) diff --git a/docs/content/references/services/classes/InventoryService.md b/docs/content/references/services/classes/InventoryService.md index e890c07d48..a4b01d550d 100644 --- a/docs/content/references/services/classes/InventoryService.md +++ b/docs/content/references/services/classes/InventoryService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L18) +[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L18) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/inventory.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L15) +[packages/medusa/src/services/inventory.ts:15](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L15) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/inventory.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L13) +[packages/medusa/src/services/inventory.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L13) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/inventory.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L16) +[packages/medusa/src/services/inventory.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L16) ## Methods @@ -115,7 +115,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/inventory.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L31) +[packages/medusa/src/services/inventory.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L31) ___ @@ -154,7 +154,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -181,7 +181,7 @@ true if the inventory covers the quantity #### Defined in -[packages/medusa/src/services/inventory.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/inventory.ts#L63) +[packages/medusa/src/services/inventory.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/inventory.ts#L64) ___ @@ -205,7 +205,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -229,4 +229,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/LineItemAdjustmentService.md b/docs/content/references/services/classes/LineItemAdjustmentService.md new file mode 100644 index 0000000000..420de0bde9 --- /dev/null +++ b/docs/content/references/services/classes/LineItemAdjustmentService.md @@ -0,0 +1,392 @@ +# Class: LineItemAdjustmentService + +Provides layer to manipulate line item adjustments. + +## Hierarchy + +- `TransactionBaseService` + + ↳ **`LineItemAdjustmentService`** + +## Constructors + +### constructor + +• **new LineItemAdjustmentService**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `LineItemAdjustmentServiceProps` | + +#### Overrides + +TransactionBaseService.constructor + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L44) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### discountService + +• `Private` `Readonly` **discountService**: [`DiscountService`](DiscountService.md) + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L42) + +___ + +### lineItemAdjustmentRepo\_ + +• `Private` `Readonly` **lineItemAdjustmentRepo\_**: typeof `LineItemAdjustmentRepository` + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L41) + +___ + +### manager\_ + +• `Protected` `Readonly` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L38) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L39) + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) + +___ + +### create + +▸ **create**(`data`): `Promise`<`LineItemAdjustment`\> + +Creates a line item adjustment + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | `Partial`<`LineItemAdjustment`\> | the line item adjustment to create | + +#### Returns + +`Promise`<`LineItemAdjustment`\> + +line item adjustment + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:88](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L88) + +___ + +### createAdjustmentForLineItem + +▸ **createAdjustmentForLineItem**(`cart`, `lineItem`): `Promise`<`LineItemAdjustment`[]\> + +Creates adjustment for a line item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | `Cart` | the cart object holding discounts | +| `lineItem` | `LineItem` | the line item for which a line item adjustment might be created | + +#### Returns + +`Promise`<`LineItemAdjustment`[]\> + +a line item adjustment or undefined if no adjustment was created + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:249](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L249) + +___ + +### createAdjustments + +▸ **createAdjustments**(`cart`, `lineItem?`): `Promise`<`LineItemAdjustment`[] \| `LineItemAdjustment`[][]\> + +Creates adjustment for a line item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | `Cart` | the cart object holding discounts | +| `lineItem?` | `LineItem` | the line item for which a line item adjustment might be created | + +#### Returns + +`Promise`<`LineItemAdjustment`[] \| `LineItemAdjustment`[][]\> + +if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created +otherwise returns an array of line item adjustments for each line item in the cart + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:277](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L277) + +___ + +### delete + +▸ **delete**(`selectorOrIds`): `Promise`<`void`\> + +Deletes line item adjustments matching a selector + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selectorOrIds` | `string` \| `string`[] \| `FilterableLineItemAdjustmentProps` | the query object for find or the line item adjustment id | + +#### Returns + +`Promise`<`void`\> + +the result of the delete operation + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:153](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L153) + +___ + +### generateAdjustments + +▸ **generateAdjustments**(`cart`, `generatedLineItem`, `context`): `Promise`<`GeneratedAdjustment`[]\> + +Creates adjustment for a line item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | `Cart` | the cart object holding discounts | +| `generatedLineItem` | `LineItem` | the line item for which a line item adjustment might be created | +| `context` | `AdjustmentContext` | the line item for which a line item adjustment might be created | + +#### Returns + +`Promise`<`GeneratedAdjustment`[]\> + +a line item adjustment or undefined if no adjustment was created + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:182](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L182) + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<`LineItemAdjustment`[]\> + +Lists line item adjustments + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `FilterableLineItemAdjustmentProps` | the query object for find | +| `config` | `FindConfig`<`LineItemAdjustment`\> | the config to be used for find | + +#### Returns + +`Promise`<`LineItemAdjustment`[]\> + +the result of the find operation + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:136](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L136) + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<`LineItemAdjustment`\> + +Retrieves a line item adjustment by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the line item adjustment to retrieve | +| `config` | `FindConfig`<`LineItemAdjustment`\> | the config to retrieve the line item adjustment by | + +#### Returns + +`Promise`<`LineItemAdjustment`\> + +the line item adjustment. + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L63) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<`LineItemAdjustment`\> + +Creates a line item adjustment + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the line item adjustment id to update | +| `data` | `Partial`<`LineItemAdjustment`\> | the line item adjustment to create | + +#### Returns + +`Promise`<`LineItemAdjustment`\> + +line item adjustment + +#### Defined in + +[packages/medusa/src/services/line-item-adjustment.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item-adjustment.ts#L105) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`LineItemAdjustmentService`](LineItemAdjustmentService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`LineItemAdjustmentService`](LineItemAdjustmentService.md) + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/LineItemService.md b/docs/content/references/services/classes/LineItemService.md index 54cc0e1d0b..82a466a85f 100644 --- a/docs/content/references/services/classes/LineItemService.md +++ b/docs/content/references/services/classes/LineItemService.md @@ -1,10 +1,8 @@ # Class: LineItemService -Provides layer to manipulate line items. - ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService` ↳ **`LineItemService`** @@ -22,21 +20,49 @@ Provides layer to manipulate line items. #### Overrides -BaseService.constructor +TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/line-item.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L52) +[packages/medusa/src/services/line-item.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L53) ## Properties +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + ### cartRepository\_ • `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository` #### Defined in -[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L44) +[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L44) ___ @@ -46,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L49) +[packages/medusa/src/services/line-item.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L49) ___ @@ -56,17 +82,17 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L43) +[packages/medusa/src/services/line-item.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L43) ___ ### lineItemAdjustmentService\_ -• `Protected` `Readonly` **lineItemAdjustmentService\_**: `LineItemAdjustmentService` +• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md) #### Defined in -[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L50) +[packages/medusa/src/services/line-item.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L50) ___ @@ -76,17 +102,21 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L42) +[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L42) ___ ### manager\_ -• `Protected` `Readonly` **manager\_**: `EntityManager` +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/line-item.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L41) +[packages/medusa/src/services/line-item.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L39) ___ @@ -96,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L47) +[packages/medusa/src/services/line-item.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L47) ___ @@ -106,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L46) +[packages/medusa/src/services/line-item.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L46) ___ @@ -116,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L45) +[packages/medusa/src/services/line-item.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L45) ___ @@ -126,10 +156,137 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L48) +[packages/medusa/src/services/line-item.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L48) + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](TaxProviderService.md) + +#### Defined in + +[packages/medusa/src/services/line-item.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L51) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/line-item.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L40) ## Methods +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) + +___ + +### cloneTo + +▸ **cloneTo**(`ids`, `data?`, `options?`): `Promise`<`LineItem`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ids` | `string` \| `string`[] | +| `data` | `Object` | +| `data.adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; }...)[] | +| `data.allow_discounts?` | `boolean` | +| `data.cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: ... | +| `data.cart_id?` | `string` | +| `data.claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } | +| `data.claim_order_id?` | `string` | +| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.description?` | `string` | +| `data.discount_total?` | ``null`` \| `number` | +| `data.fulfilled_quantity?` | `number` | +| `data.gift_card_total?` | ``null`` \| `number` | +| `data.has_shipping?` | `boolean` | +| `data.id?` | `string` | +| `data.includes_tax?` | `boolean` | +| `data.is_giftcard?` | `boolean` | +| `data.is_return?` | `boolean` | +| `data.metadata?` | { [x: string]: unknown; } | +| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.order_edit_id?` | ``null`` \| `string` | +| `data.order_id?` | ``null`` \| `string` | +| `data.original_item_id?` | ``null`` \| `string` | +| `data.original_tax_total?` | ``null`` \| `number` | +| `data.original_total?` | ``null`` \| `number` | +| `data.quantity?` | `number` | +| `data.refundable?` | ``null`` \| `number` | +| `data.returned_quantity?` | `number` | +| `data.shipped_quantity?` | `number` | +| `data.should_merge?` | `boolean` | +| `data.subtotal?` | ``null`` \| `number` | +| `data.swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.swap_id?` | `string` | +| `data.tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] | +| `data.tax_total?` | ``null`` \| `number` | +| `data.thumbnail?` | ``null`` \| `string` | +| `data.title?` | `string` | +| `data.total?` | ``null`` \| `number` | +| `data.unit_price?` | `number` | +| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.variant?` | { title?: string \| undefined; product\_id?: string \| undefined; product?: { title?: string \| undefined; subtitle?: string \| null \| undefined; description?: string \| null \| undefined; ... 29 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 22 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.variant_id?` | `string` | +| `options` | `Object` | +| `options.setOriginalLineItemId?` | `boolean` | + +#### Returns + +`Promise`<`LineItem`[]\> + +#### Defined in + +[packages/medusa/src/services/line-item.ts:394](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L394) + +___ + ### create ▸ **create**(`data`): `Promise`<`LineItem`\> @@ -150,7 +307,7 @@ the created line item #### Defined in -[packages/medusa/src/services/line-item.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L292) +[packages/medusa/src/services/line-item.ts:278](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L278) ___ @@ -176,7 +333,7 @@ the created line items #### Defined in -[packages/medusa/src/services/line-item.ts:149](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L149) +[packages/medusa/src/services/line-item.ts:128](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L128) ___ @@ -194,7 +351,7 @@ Create a line item tax line. | `args.code?` | ``null`` \| `string` | - | | `args.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - | | `args.id?` | `string` | - | -| `args.item?` | { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 34 more ...; updated\_at?: {... | - | +| `args.item?` | { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {... | - | | `args.item_id?` | `string` | - | | `args.metadata?` | { [x: string]: unknown; } | - | | `args.name?` | `string` | - | @@ -209,7 +366,7 @@ a new line item tax line #### Defined in -[packages/medusa/src/services/line-item.ts:359](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L359) +[packages/medusa/src/services/line-item.ts:386](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L386) ___ @@ -233,7 +390,31 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/line-item.ts:340](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L340) +[packages/medusa/src/services/line-item.ts:346](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L346) + +___ + +### deleteWithTaxLines + +▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| `LineItem`\> + +Deletes a line item with the tax lines. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the line item to delete | + +#### Returns + +`Promise`<`undefined` \| `LineItem`\> + +the result of the delete operation + +#### Defined in + +[packages/medusa/src/services/line-item.ts:365](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L365) ___ @@ -253,6 +434,7 @@ ___ | `context.customer_id?` | `string` | | `context.includes_tax?` | `boolean` | | `context.metadata?` | `Record`<`string`, `unknown`\> | +| `context.order_edit_id?` | `string` | | `context.unit_price?` | `number` | #### Returns @@ -261,7 +443,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:202](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L202) +[packages/medusa/src/services/line-item.ts:181](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L181) ___ @@ -273,7 +455,7 @@ ___ | Name | Type | | :------ | :------ | -| `selector` | `any` | +| `selector` | `Selector`<`LineItem`\> | | `config` | `FindConfig`<`LineItem`\> | #### Returns @@ -282,7 +464,7 @@ ___ #### Defined in -[packages/medusa/src/services/line-item.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L101) +[packages/medusa/src/services/line-item.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L81) ___ @@ -307,13 +489,37 @@ the line item #### Defined in -[packages/medusa/src/services/line-item.ts:121](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L121) +[packages/medusa/src/services/line-item.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L101) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ ### update -▸ **update**(`id`, `data`): `Promise`<`LineItem`\> +▸ **update**(`idOrSelector`, `data`): `Promise`<`LineItem`[]\> Updates a line item @@ -321,35 +527,39 @@ Updates a line item | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | the id of the line item to update | -| `data` | `Partial`<`LineItem`\> | the properties to update on line item | +| `idOrSelector` | `string` \| `Selector`<`LineItem`\> | the id or selector of the line item(s) to update | +| `data` | `Partial`<`LineItem`\> | the properties to update the line item(s) | #### Returns -`Promise`<`LineItem`\> +`Promise`<`LineItem`[]\> -the update line item +the updated line item(s) #### Defined in -[packages/medusa/src/services/line-item.ts:311](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L311) +[packages/medusa/src/services/line-item.ts:297](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/line-item.ts#L297) ___ ### withTransaction -▸ **withTransaction**(`transactionManager`): [`LineItemService`](LineItemService.md) +▸ **withTransaction**(`transactionManager?`): [`LineItemService`](LineItemService.md) #### Parameters | Name | Type | | :------ | :------ | -| `transactionManager` | `EntityManager` | +| `transactionManager?` | `EntityManager` | #### Returns [`LineItemService`](LineItemService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[packages/medusa/src/services/line-item.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/line-item.ts#L78) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/MiddlewareService.md b/docs/content/references/services/classes/MiddlewareService.md index 48edb125fa..b0f9341e8d 100644 --- a/docs/content/references/services/classes/MiddlewareService.md +++ b/docs/content/references/services/classes/MiddlewareService.md @@ -10,7 +10,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API #### Defined in -[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L22) +[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L22) ## Properties @@ -20,7 +20,7 @@ Orchestrates dynamic middleware registered through the Medusa Middleware API #### Defined in -[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L17) +[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L17) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L18) +[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L18) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L19) +[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L19) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L20) +[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L20) ## Methods @@ -75,7 +75,7 @@ void #### Defined in -[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L60) +[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L60) ___ @@ -100,7 +100,7 @@ void #### Defined in -[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L79) +[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L79) ___ @@ -122,7 +122,7 @@ Adds a middleware function to be called before cart creation #### Defined in -[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L96) +[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L96) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L29) +[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L29) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L34) +[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L34) ___ @@ -185,7 +185,7 @@ Adds post authentication middleware to an express app. #### Defined in -[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L106) +[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L106) ___ @@ -207,7 +207,7 @@ Adds pre authentication middleware to an express app. #### Defined in -[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L117) +[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L117) ___ @@ -221,7 +221,7 @@ ___ #### Defined in -[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L123) +[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L123) ___ @@ -245,4 +245,4 @@ nothing if the middleware is a function #### Defined in -[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/middleware.ts#L43) +[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/middleware.ts#L43) diff --git a/docs/content/references/services/classes/NoteService.md b/docs/content/references/services/classes/NoteService.md index b7b491eb9f..ea329ec5ac 100644 --- a/docs/content/references/services/classes/NoteService.md +++ b/docs/content/references/services/classes/NoteService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L29) +[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L29) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L27) +[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L27) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L24) +[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L24) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L26) +[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L26) ___ @@ -100,7 +100,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L25) +[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L25) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L18) +[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L18) ## Methods @@ -157,7 +157,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -183,7 +183,7 @@ resolves to the creation result #### Defined in -[packages/medusa/src/services/note.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L96) +[packages/medusa/src/services/note.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L96) ___ @@ -205,7 +205,7 @@ Deletes a given note #### Defined in -[packages/medusa/src/services/note.ts:154](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L154) +[packages/medusa/src/services/note.ts:154](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L154) ___ @@ -230,7 +230,7 @@ notes related to the given search. #### Defined in -[packages/medusa/src/services/note.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L75) +[packages/medusa/src/services/note.ts:75](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L75) ___ @@ -255,7 +255,7 @@ which resolves to the requested note. #### Defined in -[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L47) +[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L47) ___ @@ -279,7 +279,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -304,7 +304,7 @@ resolves to the updated element #### Defined in -[packages/medusa/src/services/note.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/note.ts#L132) +[packages/medusa/src/services/note.ts:132](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/note.ts#L132) ___ @@ -328,4 +328,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/NotificationService.md b/docs/content/references/services/classes/NotificationService.md index 1ab99ba7dd..c46418eea2 100644 --- a/docs/content/references/services/classes/NotificationService.md +++ b/docs/content/references/services/classes/NotificationService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/notification.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L35) +[packages/medusa/src/services/notification.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L36) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L27) +[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L27) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L28) +[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L28) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L31) +[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L31) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L23) +[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L23) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L33) +[packages/medusa/src/services/notification.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L34) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L32) +[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L32) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L26) +[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L26) ___ @@ -140,7 +140,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L24) +[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L24) ## Methods @@ -179,7 +179,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -206,7 +206,7 @@ the result of notification subscribed #### Defined in -[packages/medusa/src/services/notification.ts:173](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L173) +[packages/medusa/src/services/notification.ts:174](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L174) ___ @@ -231,7 +231,7 @@ the notifications that satisfy the query. #### Defined in -[packages/medusa/src/services/notification.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L85) +[packages/medusa/src/services/notification.ts:86](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L86) ___ @@ -254,7 +254,7 @@ used to generate on demand invoices or other documents. #### Defined in -[packages/medusa/src/services/notification.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L61) +[packages/medusa/src/services/notification.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L62) ___ @@ -276,7 +276,7 @@ Takes a list of notification provider ids and persists them in the database. #### Defined in -[packages/medusa/src/services/notification.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L69) +[packages/medusa/src/services/notification.ts:70](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L70) ___ @@ -302,7 +302,7 @@ the newly created notification #### Defined in -[packages/medusa/src/services/notification.ts:253](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L253) +[packages/medusa/src/services/notification.ts:254](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L254) ___ @@ -327,7 +327,7 @@ the notification #### Defined in -[packages/medusa/src/services/notification.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L106) +[packages/medusa/src/services/notification.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L107) ___ @@ -352,7 +352,7 @@ the notification provider #### Defined in -[packages/medusa/src/services/notification.ts:154](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L154) +[packages/medusa/src/services/notification.ts:155](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L155) ___ @@ -379,7 +379,7 @@ the created notification #### Defined in -[packages/medusa/src/services/notification.ts:205](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L205) +[packages/medusa/src/services/notification.ts:206](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L206) ___ @@ -403,7 +403,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -426,7 +426,7 @@ Subscribes a given provider to an event. #### Defined in -[packages/medusa/src/services/notification.ts:133](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/notification.ts#L133) +[packages/medusa/src/services/notification.ts:134](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/notification.ts#L134) ___ @@ -450,4 +450,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/OauthService.md b/docs/content/references/services/classes/OauthService.md index c96df22297..12e2746180 100644 --- a/docs/content/references/services/classes/OauthService.md +++ b/docs/content/references/services/classes/OauthService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L31) +[packages/medusa/src/services/oauth.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L31) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L27) +[packages/medusa/src/services/oauth.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L27) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L29) +[packages/medusa/src/services/oauth.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L29) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L26) +[packages/medusa/src/services/oauth.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L26) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L19) +[packages/medusa/src/services/oauth.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L19) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L28) +[packages/medusa/src/services/oauth.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L28) ___ @@ -120,7 +120,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L20) +[packages/medusa/src/services/oauth.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L20) ___ @@ -137,7 +137,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L21) +[packages/medusa/src/services/oauth.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L21) ## Methods @@ -176,7 +176,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L81) +[packages/medusa/src/services/oauth.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L81) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L119) +[packages/medusa/src/services/oauth.ts:115](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L115) ___ @@ -238,7 +238,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L73) +[packages/medusa/src/services/oauth.ts:73](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L73) ___ @@ -258,7 +258,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:153](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L153) +[packages/medusa/src/services/oauth.ts:149](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L149) ___ @@ -278,7 +278,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:109](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L109) +[packages/medusa/src/services/oauth.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L105) ___ @@ -298,7 +298,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L57) +[packages/medusa/src/services/oauth.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L57) ___ @@ -318,7 +318,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L41) +[packages/medusa/src/services/oauth.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L41) ___ @@ -342,7 +342,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -363,7 +363,7 @@ ___ #### Defined in -[packages/medusa/src/services/oauth.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/oauth.ts#L96) +[packages/medusa/src/services/oauth.ts:94](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/oauth.ts#L94) ___ @@ -387,4 +387,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/OrderEditItemChangeService.md b/docs/content/references/services/classes/OrderEditItemChangeService.md new file mode 100644 index 0000000000..912ba7a6b3 --- /dev/null +++ b/docs/content/references/services/classes/OrderEditItemChangeService.md @@ -0,0 +1,309 @@ +# Class: OrderEditItemChangeService + +## Hierarchy + +- `TransactionBaseService` + + ↳ **`OrderEditItemChangeService`** + +## Constructors + +### constructor + +• **new OrderEditItemChangeService**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `InjectedDependencies` | + +#### Overrides + +TransactionBaseService.constructor + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L34) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L30) + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L31) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L26) + +___ + +### orderItemChangeRepository\_ + +• `Protected` `Readonly` **orderItemChangeRepository\_**: typeof `OrderItemChangeRepository` + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L29) + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](TaxProviderService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L32) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L27) + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L21) + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) + +___ + +### create + +▸ **create**(`data`): `Promise`<`OrderItemChange`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `CreateOrderEditItemChangeInput` | + +#### Returns + +`Promise`<`OrderItemChange`\> + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:86](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L86) + +___ + +### delete + +▸ **delete**(`itemChangeIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `itemChangeIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L102) + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<`OrderItemChange`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | `Selector`<`OrderItemChange`\> | +| `config` | `FindConfig`<`OrderItemChange`\> | + +#### Returns + +`Promise`<`OrderItemChange`[]\> + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:73](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L73) + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<`OrderItemChange`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `config` | `FindConfig`<`OrderItemChange`\> | + +#### Returns + +`Promise`<`OrderItemChange`\> + +#### Defined in + +[packages/medusa/src/services/order-edit-item-change.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit-item-change.ts#L51) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OrderEditItemChangeService`](OrderEditItemChangeService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`OrderEditItemChangeService`](OrderEditItemChangeService.md) + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/OrderEditService.md b/docs/content/references/services/classes/OrderEditService.md index b6fc48aab7..51fc2c8da0 100644 --- a/docs/content/references/services/classes/OrderEditService.md +++ b/docs/content/references/services/classes/OrderEditService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order-edit.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L27) +[packages/medusa/src/services/order-edit.ts:65](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L65) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,37 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L60) + +___ + +### lineItemAdjustmentService\_ + +• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L62) + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L59) ___ @@ -66,7 +96,17 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order-edit.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L23) +[packages/medusa/src/services/order-edit.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L52) + +___ + +### orderEditItemChangeService\_ + +• `Protected` `Readonly` **orderEditItemChangeService\_**: [`OrderEditItemChangeService`](OrderEditItemChangeService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L63) ___ @@ -76,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L24) +[packages/medusa/src/services/order-edit.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L55) ___ @@ -86,7 +126,27 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L25) +[packages/medusa/src/services/order-edit.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L57) + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](TaxProviderService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:61](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L61) + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](TotalsService.md) + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L58) ___ @@ -100,10 +160,52 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order-edit.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L22) +[packages/medusa/src/services/order-edit.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L53) + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CANCELED` | `string` | +| `CONFIRMED` | `string` | +| `CREATED` | `string` | +| `DECLINED` | `string` | +| `REQUESTED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L43) ## Methods +### addLineItem + +▸ **addLineItem**(`orderEditId`, `data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `data` | `AddOrderEditLineItemInput` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:515](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L515) + +___ + ### atomicPhase\_ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> @@ -139,13 +241,142 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ -### computeLineItems +### cancel -▸ **computeLineItems**(`orderEditId`): `Promise`<{ `items`: `LineItem`[] ; `removedItems`: `LineItem`[] }\> +▸ **cancel**(`orderEditId`, `context?`): `Promise`<`OrderEdit`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `context` | `Object` | +| `context.loggedInUserId?` | `string` | + +#### Returns + +`Promise`<`OrderEdit`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:659](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L659) + +___ + +### confirm + +▸ **confirm**(`orderEditId`, `context?`): `Promise`<`OrderEdit`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `context` | `Object` | +| `context.loggedInUserId?` | `string` | + +#### Returns + +`Promise`<`OrderEdit`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:698](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L698) + +___ + +### create + +▸ **create**(`data`, `context`): `Promise`<`OrderEdit`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `CreateOrderEditInput` | +| `context` | `Object` | +| `context.loggedInUserId` | `string` | + +#### Returns + +`Promise`<`OrderEdit`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:175](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L175) + +___ + +### decline + +▸ **decline**(`orderEditId`, `context`): `Promise`<`OrderEdit`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `context` | `Object` | +| `context.declinedReason?` | `string` | +| `context.loggedInUserId?` | `string` | + +#### Returns + +`Promise`<`OrderEdit`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:277](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L277) + +___ + +### decorateTotals + +▸ **decorateTotals**(`orderEdit`): `Promise`<`OrderEdit`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEdit` | `OrderEdit` | + +#### Returns + +`Promise`<`OrderEdit`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:501](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L501) + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:253](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L253) + +___ + +### deleteClonedItems + +▸ `Protected` **deleteClonedItems**(`orderEditId`): `Promise`<`void`\> #### Parameters @@ -155,11 +386,117 @@ ___ #### Returns -`Promise`<{ `items`: `LineItem`[] ; `removedItems`: `LineItem`[] }\> +`Promise`<`void`\> #### Defined in -[packages/medusa/src/services/order-edit.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L64) +[packages/medusa/src/services/order-edit.ts:771](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L771) + +___ + +### deleteItemChange + +▸ **deleteItemChange**(`orderEditId`, `itemChangeId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `itemChangeId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:587](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L587) + +___ + +### getTotals + +▸ **getTotals**(`orderEditId`): `Promise`<{ `difference_due`: `number` ; `discount_total`: `number` ; `gift_card_tax_total`: `number` ; `gift_card_total`: `number` ; `shipping_total`: `number` ; `subtotal`: `number` ; `tax_total`: ``null`` \| `number` ; `total`: `number` }\> + +Compute and return the different totals from the order edit id + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | + +#### Returns + +`Promise`<{ `difference_due`: `number` ; `discount_total`: `number` ; `gift_card_tax_total`: `number` ; `gift_card_total`: `number` ; `shipping_total`: `number` ; `subtotal`: `number` ; `tax_total`: ``null`` \| `number` ; `total`: `number` }\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:116](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L116) + +___ + +### refreshAdjustments + +▸ **refreshAdjustments**(`orderEditId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:458](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L458) + +___ + +### removeLineItem + +▸ **removeLineItem**(`orderEditId`, `lineItemId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `lineItemId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:401](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L401) + +___ + +### requestConfirmation + +▸ **requestConfirmation**(`orderEditId`, `context?`): `Promise`<`OrderEdit`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `context` | `Object` | +| `context.loggedInUserId?` | `string` | + +#### Returns + +`Promise`<`OrderEdit`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:619](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L619) ___ @@ -180,7 +517,28 @@ ___ #### Defined in -[packages/medusa/src/services/order-edit.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order-edit.ts#L40) +[packages/medusa/src/services/order-edit.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L90) + +___ + +### retrieveActive + +▸ `Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| `OrderEdit`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderId` | `string` | +| `config` | `FindConfig`<`OrderEdit`\> | + +#### Returns + +`Promise`<`undefined` \| `OrderEdit`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:750](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L750) ___ @@ -204,7 +562,85 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) + +___ + +### update + +▸ **update**(`orderEditId`, `data`): `Promise`<`OrderEdit`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `data` | `Object` | +| `data.canceled_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.canceled_by?` | `string` | +| `data.changes?` | (`undefined` \| { type?: OrderEditItemChangeType \| undefined; order\_edit\_id?: string \| undefined; order\_edit?: { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; ... 51 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 7 ...)[] | +| `data.confirmed_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.confirmed_by?` | `string` | +| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.created_by?` | `string` | +| `data.declined_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.declined_by?` | `string` | +| `data.declined_reason?` | `string` | +| `data.difference_due?` | `number` | +| `data.discount_total?` | `number` | +| `data.gift_card_tax_total?` | `number` | +| `data.gift_card_total?` | `number` | +| `data.id?` | `string` | +| `data.internal_note?` | `string` | +| `data.items?` | (`undefined` \| { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {...)[] | +| `data.order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.order_id?` | `string` | +| `data.payment_collection?` | { type?: PaymentCollectionType \| undefined; status?: PaymentCollectionStatus \| undefined; description?: string \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.payment_collection_id?` | `string` | +| `data.requested_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.requested_by?` | `string` | +| `data.shipping_total?` | `number` | +| `data.status?` | `OrderEditStatus` | +| `data.subtotal?` | `number` | +| `data.tax_total?` | ``null`` \| `number` | +| `data.total?` | `number` | +| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.loadStatus?` | | + +#### Returns + +`Promise`<`OrderEdit`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:224](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L224) + +___ + +### updateLineItem + +▸ **updateLineItem**(`orderEditId`, `itemId`, `data`): `Promise`<`void`\> + +Create or update order edit item change line item and apply the quantity +- If the item change already exists then update the quantity of the line item as well as the line adjustments +- If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `itemId` | `string` | +| `data` | `Object` | +| `data.quantity` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:328](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L328) ___ @@ -228,4 +664,24 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### isOrderEditActive + +▸ `Static` `Private` **isOrderEditActive**(`orderEdit`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEdit` | `OrderEdit` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/medusa/src/services/order-edit.ts:808](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order-edit.ts#L808) diff --git a/docs/content/references/services/classes/OrderService.md b/docs/content/references/services/classes/OrderService.md index e821d0c764..3e354ccbe7 100644 --- a/docs/content/references/services/classes/OrderService.md +++ b/docs/content/references/services/classes/OrderService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L108) +[packages/medusa/src/services/order.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L111) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:102](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L102) +[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L104) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L101) +[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L103) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L91) +[packages/medusa/src/services/order.ts:93](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L93) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:95](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L95) +[packages/medusa/src/services/order.ts:97](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L97) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L104) +[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L106) ___ @@ -112,7 +112,17 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L106) +[packages/medusa/src/services/order.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L108) + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter` + +#### Defined in + +[packages/medusa/src/services/order.ts:109](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L109) ___ @@ -122,7 +132,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L96) +[packages/medusa/src/services/order.ts:98](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L98) ___ @@ -132,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:97](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L97) +[packages/medusa/src/services/order.ts:99](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L99) ___ @@ -142,7 +152,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L103) +[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L105) ___ @@ -152,7 +162,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L105) +[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L107) ___ @@ -162,7 +172,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:98](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L98) +[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L100) ___ @@ -176,7 +186,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/order.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L87) +[packages/medusa/src/services/order.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L89) ___ @@ -186,7 +196,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L90) +[packages/medusa/src/services/order.ts:92](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L92) ___ @@ -196,7 +206,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:92](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L92) +[packages/medusa/src/services/order.ts:94](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L94) ___ @@ -206,7 +216,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L100) +[packages/medusa/src/services/order.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L102) ___ @@ -216,7 +226,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L93) +[packages/medusa/src/services/order.ts:95](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L95) ___ @@ -226,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:94](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L94) +[packages/medusa/src/services/order.ts:96](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L96) ___ @@ -236,7 +246,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L99) +[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L101) ___ @@ -250,7 +260,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/order.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L88) +[packages/medusa/src/services/order.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L90) ___ @@ -281,7 +291,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L68) +[packages/medusa/src/services/order.ts:70](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L70) ## Methods @@ -304,7 +314,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:831](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L831) +[packages/medusa/src/services/order.ts:835](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L835) ___ @@ -329,7 +339,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:1360](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1360) +[packages/medusa/src/services/order.ts:1361](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1361) ___ @@ -368,7 +378,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -394,7 +404,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:985](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L985) +[packages/medusa/src/services/order.ts:988](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L988) ___ @@ -418,7 +428,7 @@ updated order #### Defined in -[packages/medusa/src/services/order.ts:1297](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1297) +[packages/medusa/src/services/order.ts:1298](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1298) ___ @@ -442,7 +452,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1064](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1064) +[packages/medusa/src/services/order.ts:1066](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1066) ___ @@ -464,7 +474,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:464](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L464) +[packages/medusa/src/services/order.ts:462](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L462) ___ @@ -488,7 +498,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/order.ts:492](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L492) +[packages/medusa/src/services/order.ts:490](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L490) ___ @@ -519,7 +529,7 @@ result of the update operation. #### Defined in -[packages/medusa/src/services/order.ts:1170](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1170) +[packages/medusa/src/services/order.ts:1171](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1171) ___ @@ -548,7 +558,7 @@ the result of the refund operation. #### Defined in -[packages/medusa/src/services/order.ts:1386](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1386) +[packages/medusa/src/services/order.ts:1387](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1387) ___ @@ -579,7 +589,7 @@ the resulting order following the update. #### Defined in -[packages/medusa/src/services/order.ts:671](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L671) +[packages/medusa/src/services/order.ts:675](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L675) ___ @@ -600,7 +610,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:1435](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1435) +[packages/medusa/src/services/order.ts:1436](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1436) ___ @@ -624,7 +634,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:455](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L455) +[packages/medusa/src/services/order.ts:453](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L453) ___ @@ -650,7 +660,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/order.ts:1339](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1339) +[packages/medusa/src/services/order.ts:1340](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1340) ___ @@ -673,7 +683,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:156](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L156) +[packages/medusa/src/services/order.ts:161](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L161) ___ @@ -696,7 +706,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/order.ts:191](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L191) +[packages/medusa/src/services/order.ts:195](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L195) ___ @@ -728,7 +738,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:1556](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1556) +[packages/medusa/src/services/order.ts:1557](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1557) ___ @@ -753,7 +763,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:334](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L334) +[packages/medusa/src/services/order.ts:335](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L335) ___ @@ -778,7 +788,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:375](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L375) +[packages/medusa/src/services/order.ts:375](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L375) ___ @@ -803,7 +813,7 @@ the order document #### Defined in -[packages/medusa/src/services/order.ts:415](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L415) +[packages/medusa/src/services/order.ts:414](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L414) ___ @@ -827,7 +837,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -853,7 +863,7 @@ ___ #### Defined in -[packages/medusa/src/services/order.ts:257](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L257) +[packages/medusa/src/services/order.ts:260](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L260) ___ @@ -880,7 +890,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/order.ts:896](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L896) +[packages/medusa/src/services/order.ts:899](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L899) ___ @@ -905,7 +915,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:759](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L759) +[packages/medusa/src/services/order.ts:763](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L763) ___ @@ -930,7 +940,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/order.ts:799](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L799) +[packages/medusa/src/services/order.ts:803](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L803) ___ @@ -959,7 +969,7 @@ a line item that has the requested fulfillment quantity #### Defined in -[packages/medusa/src/services/order.ts:1137](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/order.ts#L1137) +[packages/medusa/src/services/order.ts:1138](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/order.ts#L1138) ___ @@ -983,4 +993,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PaymentCollectionService.md b/docs/content/references/services/classes/PaymentCollectionService.md new file mode 100644 index 0000000000..3d3a6bf091 --- /dev/null +++ b/docs/content/references/services/classes/PaymentCollectionService.md @@ -0,0 +1,308 @@ +# Class: PaymentCollectionService + +## Hierarchy + +- `TransactionBaseService` + + ↳ **`PaymentCollectionService`** + +## Constructors + +### constructor + +• **new PaymentCollectionService**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `InjectedDependencies` | + +#### Overrides + +TransactionBaseService.constructor + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L32) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md) + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L28) + +___ + +### manager\_ + +• `Protected` `Readonly` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L26) + +___ + +### paymentCollectionRepository\_ + +• `Protected` `Readonly` **paymentCollectionRepository\_**: typeof `PaymentCollectionRepository` + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L30) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L27) + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:20](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L20) + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) + +___ + +### create + +▸ **create**(`data`): `Promise`<`PaymentCollection`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `CreatePaymentCollectionInput` | + +#### Returns + +`Promise`<`PaymentCollection`\> + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L67) + +___ + +### delete + +▸ **delete**(`paymentCollectionId`): `Promise`<`undefined` \| `PaymentCollection`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentCollectionId` | `string` | + +#### Returns + +`Promise`<`undefined` \| `PaymentCollection`\> + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:126](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L126) + +___ + +### retrieve + +▸ **retrieve**(`paymentCollectionId`, `config?`): `Promise`<`PaymentCollection`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentCollectionId` | `string` | +| `config` | `FindConfig`<`PaymentCollection`\> | + +#### Returns + +`Promise`<`PaymentCollection`\> + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L45) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) + +___ + +### update + +▸ **update**(`paymentCollectionId`, `data`): `Promise`<`PaymentCollection`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentCollectionId` | `string` | +| `data` | `Object` | +| `data.amount?` | `number` | +| `data.authorized_amount?` | `number` | +| `data.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.created_by?` | `string` | +| `data.currency?` | { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; includes\_tax?: boolean \| undefined; } | +| `data.currency_code?` | `string` | +| `data.deleted_at?` | ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | +| `data.description?` | `string` | +| `data.id?` | `string` | +| `data.metadata?` | { [x: string]: unknown; } | +| `data.payment_sessions?` | (`undefined` \| { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| ... 1 more ... \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: {...)[] | +| `data.payments?` | (`undefined` \| { swap\_id?: string \| undefined; swap?: { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; ... 21 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; })[] | +| `data.refunded_amount?` | `number` | +| `data.region?` | { name?: string \| undefined; currency\_code?: string \| undefined; currency?: { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; includes\_tax?: boolean \| undefined; } \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } | +| `data.region_id?` | `string` | +| `data.status?` | `PaymentCollectionStatus` | +| `data.type?` | `ORDER_EDIT` | +| `data.updated_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | + +#### Returns + +`Promise`<`PaymentCollection`\> + +#### Defined in + +[packages/medusa/src/services/payment-collection.ts:97](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-collection.ts#L97) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentCollectionService`](PaymentCollectionService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`PaymentCollectionService`](PaymentCollectionService.md) + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PaymentProviderService.md b/docs/content/references/services/classes/PaymentProviderService.md index 34e8e23f52..ad8c46feff 100644 --- a/docs/content/references/services/classes/PaymentProviderService.md +++ b/docs/content/references/services/classes/PaymentProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/payment-provider.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L45) +[packages/medusa/src/services/payment-provider.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L46) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L39) +[packages/medusa/src/services/payment-provider.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L39) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/payment-provider.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L37) +[packages/medusa/src/services/payment-provider.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L37) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L41) +[packages/medusa/src/services/payment-provider.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L42) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L42) +[packages/medusa/src/services/payment-provider.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L43) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L40) +[packages/medusa/src/services/payment-provider.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L40) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L43) +[packages/medusa/src/services/payment-provider.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L44) ___ @@ -132,7 +132,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/payment-provider.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L38) +[packages/medusa/src/services/payment-provider.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L38) ## Methods @@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -192,7 +192,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:349](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L349) +[packages/medusa/src/services/payment-provider.ts:350](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L350) ___ @@ -212,7 +212,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:398](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L398) +[packages/medusa/src/services/payment-provider.ts:399](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L399) ___ @@ -232,7 +232,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:423](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L423) +[packages/medusa/src/services/payment-provider.ts:424](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L424) ___ @@ -252,7 +252,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:300](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L300) +[packages/medusa/src/services/payment-provider.ts:301](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L301) ___ @@ -277,7 +277,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L158) +[packages/medusa/src/services/payment-provider.ts:159](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L159) ___ @@ -297,7 +297,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:246](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L246) +[packages/medusa/src/services/payment-provider.ts:247](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L247) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:418](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L418) +[packages/medusa/src/services/payment-provider.ts:419](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L419) ___ @@ -331,7 +331,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L75) +[packages/medusa/src/services/payment-provider.ts:76](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L76) ___ @@ -352,7 +352,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L110) +[packages/medusa/src/services/payment-provider.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L111) ___ @@ -378,7 +378,7 @@ the payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:189](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L189) +[packages/medusa/src/services/payment-provider.ts:190](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L190) ___ @@ -401,7 +401,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:443](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L443) +[packages/medusa/src/services/payment-provider.ts:444](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L444) ___ @@ -421,7 +421,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L56) +[packages/medusa/src/services/payment-provider.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L57) ___ @@ -442,13 +442,13 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L82) +[packages/medusa/src/services/payment-provider.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L83) ___ ### retrieveProvider -▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends `AbstractPaymentService`<`never`\> ? `AbstractPaymentService`<`never`\> : `any` +▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `any` Finds a provider given an id @@ -466,13 +466,13 @@ Finds a provider given an id #### Returns -`TProvider` extends `AbstractPaymentService`<`never`\> ? `AbstractPaymentService`<`never`\> : `any` +`TProvider` extends `AbstractPaymentService` ? `AbstractPaymentService` : `any` the payment provider #### Defined in -[packages/medusa/src/services/payment-provider.ts:276](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L276) +[packages/medusa/src/services/payment-provider.ts:277](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L277) ___ @@ -493,7 +493,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:527](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L527) +[packages/medusa/src/services/payment-provider.ts:528](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L528) ___ @@ -514,7 +514,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:123](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L123) +[packages/medusa/src/services/payment-provider.ts:124](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L124) ___ @@ -538,7 +538,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -561,7 +561,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:327](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L327) +[packages/medusa/src/services/payment-provider.ts:328](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L328) ___ @@ -586,7 +586,7 @@ the updated payment session #### Defined in -[packages/medusa/src/services/payment-provider.ts:228](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L228) +[packages/medusa/src/services/payment-provider.ts:229](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L229) ___ @@ -607,7 +607,7 @@ ___ #### Defined in -[packages/medusa/src/services/payment-provider.ts:377](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/payment-provider.ts#L377) +[packages/medusa/src/services/payment-provider.ts:378](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/payment-provider.ts#L378) ___ @@ -631,4 +631,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PriceListService.md b/docs/content/references/services/classes/PriceListService.md new file mode 100644 index 0000000000..d6474d54b4 --- /dev/null +++ b/docs/content/references/services/classes/PriceListService.md @@ -0,0 +1,615 @@ +# Class: PriceListService + +Provides layer to manipulate product tags. + +## Hierarchy + +- `TransactionBaseService` + + ↳ **`PriceListService`** + +## Constructors + +### constructor + +• **new PriceListService**(`__namedParameters`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `PriceListConstructorProps` | + +#### Overrides + +TransactionBaseService.constructor + +#### Defined in + +[packages/medusa/src/services/price-list.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L58) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### customerGroupService\_ + +• `Protected` `Readonly` **customerGroupService\_**: [`CustomerGroupService`](CustomerGroupService.md) + +#### Defined in + +[packages/medusa/src/services/price-list.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L49) + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter` + +#### Defined in + +[packages/medusa/src/services/price-list.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L56) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/price-list.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L46) + +___ + +### moneyAmountRepo\_ + +• `Protected` `Readonly` **moneyAmountRepo\_**: typeof `MoneyAmountRepository` + +#### Defined in + +[packages/medusa/src/services/price-list.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L54) + +___ + +### priceListRepo\_ + +• `Protected` `Readonly` **priceListRepo\_**: typeof `PriceListRepository` + +#### Defined in + +[packages/medusa/src/services/price-list.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L53) + +___ + +### productService\_ + +• `Protected` `Readonly` **productService\_**: [`ProductService`](ProductService.md) + +#### Defined in + +[packages/medusa/src/services/price-list.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L51) + +___ + +### productVariantRepo\_ + +• `Protected` `Readonly` **productVariantRepo\_**: typeof `ProductVariantRepository` + +#### Defined in + +[packages/medusa/src/services/price-list.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L55) + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md) + +#### Defined in + +[packages/medusa/src/services/price-list.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L50) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/price-list.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L47) + +___ + +### variantService\_ + +• `Protected` `Readonly` **variantService\_**: [`ProductVariantService`](ProductVariantService.md) + +#### Defined in + +[packages/medusa/src/services/price-list.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L52) + +## Methods + +### addCurrencyFromRegion + +▸ `Protected` **addCurrencyFromRegion**<`T`\>(`prices`): `Promise`<`T`[]\> + +Add `currency_code` to an MA record if `region_id`is passed. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `PriceListPriceUpdateInput` \| `PriceListPriceCreateInput` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `prices` | `T`[] | a list of PriceListPrice(Create/Update)Input records | + +#### Returns + +`Promise`<`T`[]\> + +updated `prices` list + +#### Defined in + +[packages/medusa/src/services/price-list.ts:517](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L517) + +___ + +### addPrices + +▸ **addPrices**(`id`, `prices`, `replace?`): `Promise`<`PriceList`\> + +Adds prices to a price list in bulk, optionally replacing all existing prices + +#### Parameters + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `id` | `string` | `undefined` | id of the price list | +| `prices` | `PriceListPriceCreateInput`[] | `undefined` | prices to add | +| `replace` | `boolean` | `false` | whether to replace existing prices | + +#### Returns + +`Promise`<`PriceList`\> + +updated Price List + +#### Defined in + +[packages/medusa/src/services/price-list.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L216) + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) + +___ + +### clearPrices + +▸ **clearPrices**(`id`): `Promise`<`void`\> + +Removes all prices from a price list and deletes the removed prices in bulk + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the price list | + +#### Returns + +`Promise`<`void`\> + +updated Price List + +#### Defined in + +[packages/medusa/src/services/price-list.ts:256](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L256) + +___ + +### create + +▸ **create**(`priceListObject`): `Promise`<`PriceList`\> + +Creates a Price List + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `priceListObject` | `CreatePriceListInput` | the Price List to create | + +#### Returns + +`Promise`<`PriceList`\> + +created Price List + +#### Defined in + +[packages/medusa/src/services/price-list.ts:113](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L113) + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +Deletes a Price List +Will never fail due to delete being idempotent. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the price list | + +#### Returns + +`Promise`<`void`\> + +empty promise + +#### Defined in + +[packages/medusa/src/services/price-list.ts:270](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L270) + +___ + +### deletePrices + +▸ **deletePrices**(`id`, `priceIds`): `Promise`<`void`\> + +Removes prices from a price list and deletes the removed prices in bulk + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the price list | +| `priceIds` | `string`[] | ids of the prices to delete | + +#### Returns + +`Promise`<`void`\> + +updated Price List + +#### Defined in + +[packages/medusa/src/services/price-list.ts:241](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L241) + +___ + +### deleteProductPrices + +▸ **deleteProductPrices**(`priceListId`, `productIds`): `Promise`<[`string`[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `productIds` | `string`[] | + +#### Returns + +`Promise`<[`string`[], `number`]\> + +#### Defined in + +[packages/medusa/src/services/price-list.ts:444](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L444) + +___ + +### deleteVariantPrices + +▸ **deleteVariantPrices**(`priceListId`, `variantIds`): `Promise`<[`string`[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `variantIds` | `string`[] | + +#### Returns + +`Promise`<[`string`[], `number`]\> + +#### Defined in + +[packages/medusa/src/services/price-list.ts:481](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L481) + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<`PriceList`[]\> + +Lists Price Lists + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `FilterablePriceListProps` | the query object for find | +| `config` | `FindConfig`<`FilterablePriceListProps`\> | the config to be used for find | + +#### Returns + +`Promise`<`PriceList`[]\> + +the result of the find operation + +#### Defined in + +[packages/medusa/src/services/price-list.ts:290](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L290) + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[`PriceList`[], `number`]\> + +Lists Price Lists and adds count + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `FilterablePriceListProps` | the query object for find | +| `config` | `FindConfig`<`FilterablePriceListProps`\> | the config to be used for find | + +#### Returns + +`Promise`<[`PriceList`[], `number`]\> + +the result of the find operation + +#### Defined in + +[packages/medusa/src/services/price-list.ts:314](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L314) + +___ + +### listProducts + +▸ **listProducts**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[`Product`[], `number`]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `priceListId` | `string` | `undefined` | +| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | `{}` | +| `config` | `FindConfig`<`Product`\> | `undefined` | +| `requiresPriceList` | `boolean` | `false` | + +#### Returns + +`Promise`<[`Product`[], `number`]\> + +#### Defined in + +[packages/medusa/src/services/price-list.ts:362](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L362) + +___ + +### listVariants + +▸ **listVariants**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[`ProductVariant`[], `number`]\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `priceListId` | `string` | `undefined` | +| `selector` | `FilterableProductVariantProps` | `{}` | +| `config` | `FindConfig`<`ProductVariant`\> | `undefined` | +| `requiresPriceList` | `boolean` | `false` | + +#### Returns + +`Promise`<[`ProductVariant`[], `number`]\> + +#### Defined in + +[packages/medusa/src/services/price-list.ts:410](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L410) + +___ + +### retrieve + +▸ **retrieve**(`priceListId`, `config?`): `Promise`<`PriceList`\> + +Retrieves a product tag by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `priceListId` | `string` | the id of the product tag to retrieve | +| `config` | `FindConfig`<`PriceList`\> | the config to retrieve the tag by | + +#### Returns + +`Promise`<`PriceList`\> + +the collection. + +#### Defined in + +[packages/medusa/src/services/price-list.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L89) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) + +___ + +### update + +▸ **update**(`id`, `update`): `Promise`<`PriceList`\> + +Updates a Price List + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the Product List to update | +| `update` | `UpdatePriceListInput` | the update to apply | + +#### Returns + +`Promise`<`PriceList`\> + +updated Price List + +#### Defined in + +[packages/medusa/src/services/price-list.ts:165](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L165) + +___ + +### upsertCustomerGroups\_ + +▸ `Protected` **upsertCustomerGroups_**(`priceListId`, `customerGroups`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `customerGroups` | { `id`: `string` }[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/price-list.ts:343](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/price-list.ts#L343) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PriceListService`](PriceListService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`PriceListService`](PriceListService.md) + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/PricingService.md b/docs/content/references/services/classes/PricingService.md index 119919bf84..723fc88831 100644 --- a/docs/content/references/services/classes/PricingService.md +++ b/docs/content/references/services/classes/PricingService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/pricing.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L45) +[packages/medusa/src/services/pricing.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L44) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L43) +[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L42) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L37) +[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L36) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L41) +[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L40) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L42) +[packages/medusa/src/services/pricing.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L41) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L39) +[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L38) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L40) +[packages/medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L39) ___ @@ -132,7 +132,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L38) +[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L37) ## Methods @@ -171,7 +171,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -196,7 +196,7 @@ The tax related variant prices. #### Defined in -[packages/medusa/src/services/pricing.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L105) +[packages/medusa/src/services/pricing.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L104) ___ @@ -221,7 +221,7 @@ The pricing context #### Defined in -[packages/medusa/src/services/pricing.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L70) +[packages/medusa/src/services/pricing.ts:69](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L69) ___ @@ -247,7 +247,7 @@ A map of variant ids to their corresponding prices #### Defined in -[packages/medusa/src/services/pricing.ts:324](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L324) +[packages/medusa/src/services/pricing.ts:323](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L323) ___ @@ -272,7 +272,7 @@ A map of variant ids to their corresponding prices #### Defined in -[packages/medusa/src/services/pricing.ts:342](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L342) +[packages/medusa/src/services/pricing.ts:341](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L341) ___ @@ -294,7 +294,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:286](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L286) +[packages/medusa/src/services/pricing.ts:285](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L285) ___ @@ -319,7 +319,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L214) +[packages/medusa/src/services/pricing.ts:213](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L213) ___ @@ -344,7 +344,7 @@ The product variant prices #### Defined in -[packages/medusa/src/services/pricing.ts:252](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L252) +[packages/medusa/src/services/pricing.ts:251](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L251) ___ @@ -366,7 +366,7 @@ ___ #### Defined in -[packages/medusa/src/services/pricing.ts:167](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L167) +[packages/medusa/src/services/pricing.ts:166](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L166) ___ @@ -391,7 +391,7 @@ The shipping option prices #### Defined in -[packages/medusa/src/services/pricing.ts:428](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L428) +[packages/medusa/src/services/pricing.ts:427](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L427) ___ @@ -416,7 +416,7 @@ A list of products with variants decorated with prices #### Defined in -[packages/medusa/src/services/pricing.ts:385](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L385) +[packages/medusa/src/services/pricing.ts:384](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L384) ___ @@ -441,7 +441,7 @@ A list of shipping options with prices #### Defined in -[packages/medusa/src/services/pricing.ts:490](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L490) +[packages/medusa/src/services/pricing.ts:489](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L489) ___ @@ -466,7 +466,7 @@ A list of products with variants decorated with prices #### Defined in -[packages/medusa/src/services/pricing.ts:360](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/pricing.ts#L360) +[packages/medusa/src/services/pricing.ts:359](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/pricing.ts#L359) ___ @@ -490,7 +490,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -514,4 +514,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductCollectionService.md b/docs/content/references/services/classes/ProductCollectionService.md index 45a0be4fd3..1dea641a2b 100644 --- a/docs/content/references/services/classes/ProductCollectionService.md +++ b/docs/content/references/services/classes/ProductCollectionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-collection.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L35) +[packages/medusa/src/services/product-collection.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L35) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L30) +[packages/medusa/src/services/product-collection.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L30) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L27) +[packages/medusa/src/services/product-collection.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L27) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L32) +[packages/medusa/src/services/product-collection.ts:32](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L32) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L33) +[packages/medusa/src/services/product-collection.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L33) ___ @@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L28) +[packages/medusa/src/services/product-collection.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L28) ## Methods @@ -133,7 +133,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product-collection.ts:184](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L184) +[packages/medusa/src/services/product-collection.ts:179](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L179) ___ @@ -172,7 +172,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -196,7 +196,7 @@ created collection #### Defined in -[packages/medusa/src/services/product-collection.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L113) +[packages/medusa/src/services/product-collection.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L108) ___ @@ -220,7 +220,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-collection.ts:166](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L166) +[packages/medusa/src/services/product-collection.ts:161](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L161) ___ @@ -247,7 +247,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-collection.ts:226](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L226) +[packages/medusa/src/services/product-collection.ts:221](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L221) ___ @@ -272,7 +272,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-collection.ts:244](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L244) +[packages/medusa/src/services/product-collection.ts:239](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L239) ___ @@ -293,7 +293,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-collection.ts:205](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L205) +[packages/medusa/src/services/product-collection.ts:200](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L200) ___ @@ -318,7 +318,7 @@ the collection. #### Defined in -[packages/medusa/src/services/product-collection.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L60) +[packages/medusa/src/services/product-collection.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L55) ___ @@ -343,7 +343,7 @@ the collection. #### Defined in -[packages/medusa/src/services/product-collection.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L87) +[packages/medusa/src/services/product-collection.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L82) ___ @@ -367,7 +367,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -392,7 +392,7 @@ update collection #### Defined in -[packages/medusa/src/services/product-collection.ts:136](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-collection.ts#L136) +[packages/medusa/src/services/product-collection.ts:131](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-collection.ts#L131) ___ @@ -416,4 +416,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductService.md b/docs/content/references/services/classes/ProductService.md index 15c9dee9b5..a1c40ea8c0 100644 --- a/docs/content/references/services/classes/ProductService.md +++ b/docs/content/references/services/classes/ProductService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L73) +[packages/medusa/src/services/product.ts:73](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L73) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L63) +[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L63) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L64) +[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L64) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L60) +[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L60) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L52) +[packages/medusa/src/services/product.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L52) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L55) +[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L55) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L56) +[packages/medusa/src/services/product.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L56) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L59) +[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L59) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L58) +[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L58) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L57) +[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L57) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L61) +[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L61) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L62) +[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L62) ___ @@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/product.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L53) +[packages/medusa/src/services/product.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L53) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L67) +[packages/medusa/src/services/product.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L67) ___ @@ -208,7 +208,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L66) +[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L66) ## Methods @@ -235,7 +235,7 @@ the result of the model update operation #### Defined in -[packages/medusa/src/services/product.ts:635](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L635) +[packages/medusa/src/services/product.ts:635](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L635) ___ @@ -274,7 +274,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -298,7 +298,7 @@ the result of the count operation #### Defined in -[packages/medusa/src/services/product.ts:176](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L176) +[packages/medusa/src/services/product.ts:176](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L176) ___ @@ -322,7 +322,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/product.ts:344](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L344) +[packages/medusa/src/services/product.ts:344](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L344) ___ @@ -347,7 +347,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product.ts:601](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L601) +[packages/medusa/src/services/product.ts:601](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L601) ___ @@ -372,7 +372,7 @@ the updated product #### Defined in -[packages/medusa/src/services/product.ts:800](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L800) +[packages/medusa/src/services/product.ts:800](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L800) ___ @@ -394,7 +394,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:290](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L290) +[packages/medusa/src/services/product.ts:290](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L290) ___ @@ -419,7 +419,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L110) +[packages/medusa/src/services/product.ts:110](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L110) ___ @@ -447,7 +447,7 @@ an array containing the products as #### Defined in -[packages/medusa/src/services/product.ts:146](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L146) +[packages/medusa/src/services/product.ts:146](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L146) ___ @@ -467,7 +467,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:330](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L330) +[packages/medusa/src/services/product.ts:330](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L330) ___ @@ -481,7 +481,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:321](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L321) +[packages/medusa/src/services/product.ts:321](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L321) ___ @@ -513,7 +513,7 @@ an object containing the query, relations and free-text #### Defined in -[packages/medusa/src/services/product.ts:871](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L871) +[packages/medusa/src/services/product.ts:871](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L871) ___ @@ -534,7 +534,7 @@ ___ #### Defined in -[packages/medusa/src/services/product.ts:678](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L678) +[packages/medusa/src/services/product.ts:678](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L678) ___ @@ -560,7 +560,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:191](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L191) +[packages/medusa/src/services/product.ts:191](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L191) ___ @@ -586,7 +586,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:221](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L221) +[packages/medusa/src/services/product.ts:221](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L221) ___ @@ -612,7 +612,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:207](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L207) +[packages/medusa/src/services/product.ts:207](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L207) ___ @@ -637,7 +637,7 @@ product option #### Defined in -[packages/medusa/src/services/product.ts:781](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L781) +[packages/medusa/src/services/product.ts:781](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L781) ___ @@ -662,7 +662,7 @@ an array of variants #### Defined in -[packages/medusa/src/services/product.ts:272](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L272) +[packages/medusa/src/services/product.ts:272](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L272) ___ @@ -688,7 +688,7 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product.ts:236](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L236) +[packages/medusa/src/services/product.ts:236](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L236) ___ @@ -712,7 +712,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -739,7 +739,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/product.ts:443](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L443) +[packages/medusa/src/services/product.ts:443](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L443) ___ @@ -766,7 +766,7 @@ the updated product #### Defined in -[packages/medusa/src/services/product.ts:724](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product.ts#L724) +[packages/medusa/src/services/product.ts:724](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product.ts#L724) ___ @@ -790,4 +790,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductTypeService.md b/docs/content/references/services/classes/ProductTypeService.md index 53f517ed59..dd37148cd7 100644 --- a/docs/content/references/services/classes/ProductTypeService.md +++ b/docs/content/references/services/classes/ProductTypeService.md @@ -1,10 +1,8 @@ # Class: ProductTypeService -Provides layer to manipulate products. - ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService` ↳ **`ProductTypeService`** @@ -22,34 +20,119 @@ Provides layer to manipulate products. #### Overrides -BaseService.constructor +TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-type.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L16) +[packages/medusa/src/services/product-type.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L16) ## Properties -### manager\_ +### \_\_configModule\_\_ -• `Private` **manager\_**: `EntityManager` +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/services/product-type.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L14) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/product-type.ts:11](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L11) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/product-type.ts:12](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L12) ___ ### typeRepository\_ -• `Private` **typeRepository\_**: typeof `ProductTypeRepository` +• `Protected` `Readonly` **typeRepository\_**: typeof `ProductTypeRepository` #### Defined in -[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L15) +[packages/medusa/src/services/product-type.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L14) ## Methods +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) + +___ + ### list ▸ **list**(`selector?`, `config?`): `Promise`<`ProductType`[]\> @@ -71,7 +154,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L72) +[packages/medusa/src/services/product-type.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L56) ___ @@ -96,7 +179,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-type.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L88) +[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L72) ___ @@ -122,24 +205,52 @@ the result of the find one operation. #### Defined in -[packages/medusa/src/services/product-type.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L47) +[packages/medusa/src/services/product-type.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-type.ts#L31) ___ -### withTransaction +### shouldRetryTransaction\_ -▸ **withTransaction**(`transactionManager`): [`ProductTypeService`](ProductTypeService.md) +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters | Name | Type | | :------ | :------ | -| `transactionManager` | `EntityManager` | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductTypeService`](ProductTypeService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | #### Returns [`ProductTypeService`](ProductTypeService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[packages/medusa/src/services/product-type.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-type.ts#L23) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ProductVariantService.md b/docs/content/references/services/classes/ProductVariantService.md index 4f4447e733..b9075f40d0 100644 --- a/docs/content/references/services/classes/ProductVariantService.md +++ b/docs/content/references/services/classes/ProductVariantService.md @@ -1,10 +1,8 @@ # Class: ProductVariantService -Provides layer to manipulate product variants. - ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService` ↳ **`ProductVariantService`** @@ -22,101 +20,147 @@ Provides layer to manipulate product variants. #### Overrides -BaseService.constructor +TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L53) +[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L53) ## Properties -### cartRepository\_ +### \_\_configModule\_\_ -• `Private` **cartRepository\_**: typeof `CartRepository` +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L51) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### cartRepository\_ + +• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository` + +#### Defined in + +[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L51) ___ ### eventBus\_ -• `Private` **eventBus\_**: [`EventBusService`](EventBusService.md) +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md) #### Defined in -[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L46) +[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L46) ___ ### manager\_ -• `Private` **manager\_**: `EntityManager` +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L43) +[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L41) ___ ### moneyAmountRepository\_ -• `Private` **moneyAmountRepository\_**: typeof `MoneyAmountRepository` +• `Protected` `Readonly` **moneyAmountRepository\_**: typeof `MoneyAmountRepository` #### Defined in -[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L49) +[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L49) ___ ### priceSelectionStrategy\_ -• `Private` **priceSelectionStrategy\_**: `IPriceSelectionStrategy` +• `Protected` `Readonly` **priceSelectionStrategy\_**: `IPriceSelectionStrategy` #### Defined in -[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L48) +[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L48) ___ ### productOptionValueRepository\_ -• `Private` **productOptionValueRepository\_**: typeof `ProductOptionValueRepository` +• `Protected` `Readonly` **productOptionValueRepository\_**: typeof `ProductOptionValueRepository` #### Defined in -[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L50) +[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L50) ___ ### productRepository\_ -• `Private` **productRepository\_**: typeof `ProductRepository` +• `Protected` `Readonly` **productRepository\_**: typeof `ProductRepository` #### Defined in -[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L45) +[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L45) ___ ### productVariantRepository\_ -• `Private` **productVariantRepository\_**: typeof `ProductVariantRepository` +• `Protected` `Readonly` **productVariantRepository\_**: typeof `ProductVariantRepository` #### Defined in -[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L44) +[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L44) ___ ### regionService\_ -• `Private` **regionService\_**: [`RegionService`](RegionService.md) +• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md) #### Defined in -[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L47) +[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L47) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L42) ___ @@ -134,7 +178,7 @@ ___ #### Defined in -[packages/medusa/src/services/product-variant.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L37) +[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L35) ## Methods @@ -164,7 +208,46 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/product-variant.ts:536](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L536) +[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L498) + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -190,7 +273,7 @@ resolves to the creation result. #### Defined in -[packages/medusa/src/services/product-variant.ts:184](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L184) +[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L147) ___ @@ -215,7 +298,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:689](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L689) +[packages/medusa/src/services/product-variant.ts:651](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L651) ___ @@ -241,7 +324,7 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:563](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L563) +[packages/medusa/src/services/product-variant.ts:525](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L525) ___ @@ -269,13 +352,13 @@ an array containing the products as the first element and the total #### Defined in -[packages/medusa/src/services/product-variant.ts:795](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L795) +[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L724) ___ ### getRegionPrice -▸ **getRegionPrice**(`variantId`, `context`): `Promise`<`number`\> +▸ **getRegionPrice**(`variantId`, `context`): `Promise`<``null`` \| `number`\> Gets the price specific to a region. If no region specific money amount exists the function will try to use a currency price. If no default @@ -290,13 +373,13 @@ currency price exists the function will throw an error. #### Returns -`Promise`<`number`\> +`Promise`<``null`` \| `number`\> the price specific to the region #### Defined in -[packages/medusa/src/services/product-variant.ts:411](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L411) +[packages/medusa/src/services/product-variant.ts:374](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L374) ___ @@ -319,7 +402,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-variant.ts:631](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L631) +[packages/medusa/src/services/product-variant.ts:593](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L593) ___ @@ -342,7 +425,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/product-variant.ts:590](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L590) +[packages/medusa/src/services/product-variant.ts:552](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L552) ___ @@ -374,7 +457,7 @@ an object containing the query, relations and free-text #### Defined in -[packages/medusa/src/services/product-variant.ts:756](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L756) +[packages/medusa/src/services/product-variant.ts:685](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L685) ___ @@ -399,7 +482,7 @@ the product document. #### Defined in -[packages/medusa/src/services/product-variant.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L118) +[packages/medusa/src/services/product-variant.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L83) ___ @@ -424,7 +507,7 @@ the product document. #### Defined in -[packages/medusa/src/services/product-variant.ts:148](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L148) +[packages/medusa/src/services/product-variant.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L111) ___ @@ -449,32 +532,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/product-variant.ts:477](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L477) - -___ - -### setMetadata\_ - -▸ **setMetadata_**(`variant`, `metadata`): `Record`<`string`, `unknown`\> - -Dedicated method to set metadata for a variant. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `variant` | `ProductVariant` | the variant to set metadata for. | -| `metadata` | `object` | the metadata to set | - -#### Returns - -`Record`<`string`, `unknown`\> - -updated metadata object - -#### Defined in - -[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L724) +[packages/medusa/src/services/product-variant.ts:439](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L439) ___ @@ -499,7 +557,31 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/product-variant.ts:440](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L440) +[packages/medusa/src/services/product-variant.ts:403](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L403) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -526,7 +608,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/product-variant.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L292) +[packages/medusa/src/services/product-variant.ts:255](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L255) ___ @@ -553,7 +635,7 @@ the result of the update operation. #### Defined in -[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L498) +[packages/medusa/src/services/product-variant.ts:460](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L460) ___ @@ -579,24 +661,28 @@ empty promise #### Defined in -[packages/medusa/src/services/product-variant.ts:370](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L370) +[packages/medusa/src/services/product-variant.ts:333](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L333) ___ ### withTransaction -▸ **withTransaction**(`transactionManager`): [`ProductVariantService`](ProductVariantService.md) +▸ **withTransaction**(`transactionManager?`): [`ProductVariantService`](ProductVariantService.md) #### Parameters | Name | Type | | :------ | :------ | -| `transactionManager` | `EntityManager` | +| `transactionManager?` | `EntityManager` | #### Returns [`ProductVariantService`](ProductVariantService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[packages/medusa/src/services/product-variant.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L90) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/RegionService.md b/docs/content/references/services/classes/RegionService.md index dbcbe537f6..f4965b5f23 100644 --- a/docs/content/references/services/classes/RegionService.md +++ b/docs/content/references/services/classes/RegionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/region.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L66) +[packages/medusa/src/services/region.ts:67](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L67) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L60) +[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L59) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L61) +[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L60) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L55) +[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L54) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L53) +[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L52) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L63) +[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L64) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L58) +[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L57) ___ @@ -128,7 +128,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L51) +[packages/medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L50) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L62) +[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L62) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L57) +[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L56) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L59) +[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L58) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L56) +[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L55) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L64) +[packages/medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L65) ___ @@ -192,7 +192,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L52) +[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L51) ___ @@ -210,7 +210,7 @@ ___ #### Defined in -[packages/medusa/src/services/region.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L45) +[packages/medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L44) ## Methods @@ -235,7 +235,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:572](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L572) +[packages/medusa/src/services/region.ts:573](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L573) ___ @@ -261,7 +261,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:702](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L702) +[packages/medusa/src/services/region.ts:703](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L703) ___ @@ -287,7 +287,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:651](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L651) +[packages/medusa/src/services/region.ts:652](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L652) ___ @@ -326,7 +326,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -350,7 +350,7 @@ the newly created region #### Defined in -[packages/medusa/src/services/region.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L116) +[packages/medusa/src/services/region.ts:117](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L117) ___ @@ -374,7 +374,7 @@ the result of the delete operation #### Defined in -[packages/medusa/src/services/region.ts:541](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L541) +[packages/medusa/src/services/region.ts:542](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L542) ___ @@ -399,7 +399,7 @@ result of the find operation #### Defined in -[packages/medusa/src/services/region.ts:521](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L521) +[packages/medusa/src/services/region.ts:522](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L522) ___ @@ -424,7 +424,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:610](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L610) +[packages/medusa/src/services/region.ts:611](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L611) ___ @@ -449,7 +449,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:790](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L790) +[packages/medusa/src/services/region.ts:791](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L791) ___ @@ -474,7 +474,7 @@ the updated Region #### Defined in -[packages/medusa/src/services/region.ts:751](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L751) +[packages/medusa/src/services/region.ts:752](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L752) ___ @@ -499,7 +499,7 @@ the region #### Defined in -[packages/medusa/src/services/region.ts:493](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L493) +[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L494) ___ @@ -524,7 +524,7 @@ a Region with country code #### Defined in -[packages/medusa/src/services/region.ts:436](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L436) +[packages/medusa/src/services/region.ts:437](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L437) ___ @@ -548,7 +548,7 @@ region with the matching name #### Defined in -[packages/medusa/src/services/region.ts:473](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L473) +[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L474) ___ @@ -572,7 +572,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -597,7 +597,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/region.ts:189](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L189) +[packages/medusa/src/services/region.ts:190](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L190) ___ @@ -623,7 +623,7 @@ the validated Country #### Defined in -[packages/medusa/src/services/region.ts:387](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L387) +[packages/medusa/src/services/region.ts:388](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L388) ___ @@ -651,7 +651,7 @@ void #### Defined in -[packages/medusa/src/services/region.ts:362](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L362) +[packages/medusa/src/services/region.ts:363](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L363) ___ @@ -683,7 +683,7 @@ the validated region data #### Defined in -[packages/medusa/src/services/region.ts:260](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L260) +[packages/medusa/src/services/region.ts:261](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L261) ___ @@ -711,7 +711,7 @@ void #### Defined in -[packages/medusa/src/services/region.ts:346](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/region.ts#L346) +[packages/medusa/src/services/region.ts:347](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/region.ts#L347) ___ @@ -735,4 +735,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ReturnReasonService.md b/docs/content/references/services/classes/ReturnReasonService.md index c522e6bf0e..e2ca74f251 100644 --- a/docs/content/references/services/classes/ReturnReasonService.md +++ b/docs/content/references/services/classes/ReturnReasonService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L21) +[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L21) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L18) +[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L18) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L16) +[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L16) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L19) +[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L19) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L29) +[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L29) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L110) +[packages/medusa/src/services/return-reason.ts:110](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L110) ___ @@ -192,7 +192,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L72) +[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L72) ___ @@ -217,7 +217,7 @@ the order document #### Defined in -[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L91) +[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L91) ___ @@ -241,7 +241,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -262,7 +262,7 @@ ___ #### Defined in -[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return-reason.ts#L50) +[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return-reason.ts#L50) ___ @@ -286,4 +286,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ReturnService.md b/docs/content/references/services/classes/ReturnService.md index 96157881aa..330ebfeba6 100644 --- a/docs/content/references/services/classes/ReturnService.md +++ b/docs/content/references/services/classes/ReturnService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/return.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L64) +[packages/medusa/src/services/return.ts:64](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L64) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L59) +[packages/medusa/src/services/return.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L59) ___ @@ -72,7 +72,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L61) +[packages/medusa/src/services/return.ts:61](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L61) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L56) +[packages/medusa/src/services/return.ts:56](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L56) ___ @@ -96,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/return.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L50) +[packages/medusa/src/services/return.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L50) ___ @@ -106,7 +106,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L62) +[packages/medusa/src/services/return.ts:62](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L62) ___ @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L55) +[packages/medusa/src/services/return.ts:55](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L55) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L60) +[packages/medusa/src/services/return.ts:60](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L60) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L54) +[packages/medusa/src/services/return.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L54) ___ @@ -146,7 +146,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L58) +[packages/medusa/src/services/return.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L58) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L57) +[packages/medusa/src/services/return.ts:57](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L57) ___ @@ -166,7 +166,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L53) +[packages/medusa/src/services/return.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L53) ___ @@ -180,7 +180,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/return.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L51) +[packages/medusa/src/services/return.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L51) ## Methods @@ -219,7 +219,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -243,7 +243,7 @@ the updated Return #### Defined in -[packages/medusa/src/services/return.ts:172](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L172) +[packages/medusa/src/services/return.ts:160](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L160) ___ @@ -269,7 +269,7 @@ the created return #### Defined in -[packages/medusa/src/services/return.ts:350](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L350) +[packages/medusa/src/services/return.ts:338](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L338) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:496](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L496) +[packages/medusa/src/services/return.ts:484](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L484) ___ @@ -315,7 +315,7 @@ the line items generated by the transformer. #### Defined in -[packages/medusa/src/services/return.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L114) +[packages/medusa/src/services/return.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L102) ___ @@ -338,7 +338,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/return.ts:154](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L154) +[packages/medusa/src/services/return.ts:142](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L142) ___ @@ -371,7 +371,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/return.ts:567](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L567) +[packages/medusa/src/services/return.ts:555](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L555) ___ @@ -396,7 +396,7 @@ the return #### Defined in -[packages/medusa/src/services/return.ts:270](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L270) +[packages/medusa/src/services/return.ts:258](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L258) ___ @@ -417,7 +417,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:291](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L291) +[packages/medusa/src/services/return.ts:279](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L279) ___ @@ -441,7 +441,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -462,7 +462,7 @@ ___ #### Defined in -[packages/medusa/src/services/return.ts:316](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L316) +[packages/medusa/src/services/return.ts:304](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L304) ___ @@ -493,9 +493,9 @@ a line item where the quantity is set to the requested | Name | Type | | :------ | :------ | -| `adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 35 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 35 more ...; updated\_at?: { ...; }...)[] | +| `adjustments?` | (`undefined` \| { id?: string \| undefined; item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; }...)[] | | `allow_discounts?` | `boolean` | -| `cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 34 more ...; updated\_at?: ... | +| `cart?` | { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; customer?: { ...; } \| ... 1 more ... \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 36 more ...; updated\_at?: ... | | `cart_id?` | `string` | | `claim_order?` | { payment\_status?: ClaimPaymentStatus \| undefined; fulfillment\_status?: ClaimFulfillmentStatus \| undefined; claim\_items?: ({ images?: ({ ...; } \| undefined)[] \| undefined; ... 14 more ...; updated\_at?: { ...; } \| undefined; } \| undefined)[] \| undefined; ... 17 more ...; id?: string \| undefined; } | | `claim_order_id?` | `string` | @@ -511,7 +511,10 @@ a line item where the quantity is set to the requested | `is_return?` | `boolean` | | `metadata?` | { [x: string]: unknown; } | | `order?` | { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; payment\_status?: PaymentStatus \| undefined; ... 48 more ...; updated\_at?: { ...; } \| undefined; } | -| `order_id?` | `string` | +| `order_edit?` | ``null`` \| { order\_id?: string \| undefined; order?: { readonly object?: "order" \| undefined; status?: OrderStatus \| undefined; fulfillment\_status?: FulfillmentStatus \| undefined; ... 49 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 27 more ...; updated\_at?: { ...; } \| undefined; } | +| `order_edit_id?` | ``null`` \| `string` | +| `order_id?` | ``null`` \| `string` | +| `original_item_id?` | ``null`` \| `string` | | `original_tax_total?` | ``null`` \| `number` | | `original_total?` | ``null`` \| `number` | | `quantity?` | `number` | @@ -522,7 +525,7 @@ a line item where the quantity is set to the requested | `subtotal?` | ``null`` \| `number` | | `swap?` | { fulfillment\_status?: SwapFulfillmentStatus \| undefined; payment\_status?: SwapPaymentStatus \| undefined; order\_id?: string \| undefined; ... 20 more ...; updated\_at?: { ...; } \| undefined; } | | `swap_id?` | `string` | -| `tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 35 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 35 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] | +| `tax_lines?` | (`undefined` \| { item\_id?: string \| undefined; item?: { cart\_id?: string \| undefined; cart?: { readonly object?: "cart" \| undefined; email?: string \| undefined; billing\_address\_id?: string \| undefined; ... 37 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 38 more ...; updated\_at?: { ...; } \| undefined; } \| undefin...)[] | | `tax_total?` | ``null`` \| `number` | | `thumbnail?` | ``null`` \| `string` | | `title?` | `string` | @@ -534,7 +537,7 @@ a line item where the quantity is set to the requested #### Defined in -[packages/medusa/src/services/return.ts:228](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L228) +[packages/medusa/src/services/return.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L216) ___ @@ -562,7 +565,7 @@ when statuses are not sufficient for returns. #### Defined in -[packages/medusa/src/services/return.ts:198](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/return.ts#L198) +[packages/medusa/src/services/return.ts:186](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/return.ts#L186) ___ @@ -586,4 +589,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SalesChannelService.md b/docs/content/references/services/classes/SalesChannelService.md index dd8f3598cb..9f03b5cc95 100644 --- a/docs/content/references/services/classes/SalesChannelService.md +++ b/docs/content/references/services/classes/SalesChannelService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L37) +[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L37) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L34) +[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L34) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L30) +[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L30) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L33) +[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L33) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L35) +[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L35) ___ @@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L31) +[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L31) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L24) +[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L24) ## Methods @@ -153,7 +153,7 @@ the sales channel on which the products have been added #### Defined in -[packages/medusa/src/services/sales-channel.ts:310](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L310) +[packages/medusa/src/services/sales-channel.ts:305](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L305) ___ @@ -192,7 +192,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -219,7 +219,7 @@ the created channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:167](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L167) +[packages/medusa/src/services/sales-channel.ts:162](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L162) ___ @@ -237,7 +237,7 @@ the sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:257](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L257) +[packages/medusa/src/services/sales-channel.ts:252](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L252) ___ @@ -261,7 +261,7 @@ To use this feature please enable the corresponding feature flag in your medusa #### Defined in -[packages/medusa/src/services/sales-channel.ts:218](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L218) +[packages/medusa/src/services/sales-channel.ts:213](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L213) ___ @@ -289,7 +289,7 @@ an array containing the sales channels as #### Defined in -[packages/medusa/src/services/sales-channel.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L132) +[packages/medusa/src/services/sales-channel.ts:127](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L127) ___ @@ -314,7 +314,7 @@ the sales channel on which the products have been removed #### Defined in -[packages/medusa/src/services/sales-channel.ts:289](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L289) +[packages/medusa/src/services/sales-channel.ts:284](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L284) ___ @@ -339,7 +339,7 @@ a sales channel #### Defined in -[packages/medusa/src/services/sales-channel.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L104) +[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L99) ___ @@ -364,7 +364,7 @@ a sales channel with matching name #### Defined in -[packages/medusa/src/services/sales-channel.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L118) +[packages/medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L113) ___ @@ -389,7 +389,7 @@ a single SC matching the query or throws #### Defined in -[packages/medusa/src/services/sales-channel.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L64) +[packages/medusa/src/services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L59) ___ @@ -413,7 +413,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -434,7 +434,7 @@ ___ #### Defined in -[packages/medusa/src/services/sales-channel.ts:184](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/sales-channel.ts#L184) +[packages/medusa/src/services/sales-channel.ts:179](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/sales-channel.ts#L179) ___ @@ -458,4 +458,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SearchService.md b/docs/content/references/services/classes/SearchService.md index 984d86da8e..e1c94cdeea 100644 --- a/docs/content/references/services/classes/SearchService.md +++ b/docs/content/references/services/classes/SearchService.md @@ -25,7 +25,7 @@ AbstractSearchService.constructor #### Defined in -[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L18) +[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L18) ## Properties @@ -39,7 +39,7 @@ AbstractSearchService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -53,7 +53,7 @@ AbstractSearchService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -67,7 +67,7 @@ AbstractSearchService.isDefault #### Defined in -[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L11) +[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L11) ___ @@ -77,7 +77,7 @@ ___ #### Defined in -[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L15) +[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L15) ___ @@ -91,7 +91,7 @@ AbstractSearchService.manager\_ #### Defined in -[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L13) +[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L13) ___ @@ -105,7 +105,7 @@ AbstractSearchService.options\_ #### Defined in -[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L16) +[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L16) ___ @@ -119,7 +119,7 @@ AbstractSearchService.transactionManager\_ #### Defined in -[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L14) +[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L14) ## Accessors @@ -137,13 +137,13 @@ AbstractSearchService.options #### Defined in -[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/search-service.ts#L82) +[packages/medusa/src/interfaces/search-service.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/search-service.ts#L82) ## Methods ### addDocuments -▸ **addDocuments**(`indexName`, `documents`, `type`): `void` +▸ **addDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> #### Parameters @@ -155,7 +155,7 @@ AbstractSearchService.options #### Returns -`void` +`Promise`<`void`\> #### Overrides @@ -163,7 +163,7 @@ AbstractSearchService.addDocuments #### Defined in -[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L43) +[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L43) ___ @@ -202,13 +202,13 @@ AbstractSearchService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ ### createIndex -▸ **createIndex**(`indexName`, `options`): `void` +▸ **createIndex**(`indexName`, `options`): `Promise`<`void`\> #### Parameters @@ -219,7 +219,7 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Overrides @@ -227,13 +227,13 @@ AbstractSearchService.createIndex #### Defined in -[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L31) +[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L31) ___ ### deleteAllDocuments -▸ **deleteAllDocuments**(`indexName`): `void` +▸ **deleteAllDocuments**(`indexName`): `Promise`<`void`\> #### Parameters @@ -243,7 +243,7 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Overrides @@ -251,13 +251,13 @@ AbstractSearchService.deleteAllDocuments #### Defined in -[packages/medusa/src/services/search.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L61) +[packages/medusa/src/services/search.ts:72](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L72) ___ ### deleteDocument -▸ **deleteDocument**(`indexName`, `document_id`): `void` +▸ **deleteDocument**(`indexName`, `document_id`): `Promise`<`void`\> #### Parameters @@ -268,7 +268,7 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Overrides @@ -276,13 +276,13 @@ AbstractSearchService.deleteDocument #### Defined in -[packages/medusa/src/services/search.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L55) +[packages/medusa/src/services/search.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L63) ___ ### getIndex -▸ **getIndex**(`indexName`): `void` +▸ **getIndex**(`indexName`): `Promise`<`void`\> #### Parameters @@ -292,7 +292,7 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Overrides @@ -300,13 +300,13 @@ AbstractSearchService.getIndex #### Defined in -[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L37) +[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L37) ___ ### replaceDocuments -▸ **replaceDocuments**(`indexName`, `documents`, `type`): `void` +▸ **replaceDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> #### Parameters @@ -318,7 +318,7 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Overrides @@ -326,13 +326,13 @@ AbstractSearchService.replaceDocuments #### Defined in -[packages/medusa/src/services/search.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L49) +[packages/medusa/src/services/search.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L53) ___ ### search -▸ **search**(`indexName`, `query`, `options`): `Object` +▸ **search**(`indexName`, `query`, `options`): `Promise`<{ `hits`: `unknown`[] }\> #### Parameters @@ -344,11 +344,7 @@ ___ #### Returns -`Object` - -| Name | Type | -| :------ | :------ | -| `hits` | `unknown`[] | +`Promise`<{ `hits`: `unknown`[] }\> #### Overrides @@ -356,7 +352,7 @@ AbstractSearchService.search #### Defined in -[packages/medusa/src/services/search.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L67) +[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L78) ___ @@ -380,13 +376,13 @@ AbstractSearchService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ ### updateSettings -▸ **updateSettings**(`indexName`, `settings`): `void` +▸ **updateSettings**(`indexName`, `settings`): `Promise`<`void`\> #### Parameters @@ -397,7 +393,7 @@ ___ #### Returns -`void` +`Promise`<`void`\> #### Overrides @@ -405,7 +401,7 @@ AbstractSearchService.updateSettings #### Defined in -[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/search.ts#L78) +[packages/medusa/src/services/search.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/search.ts#L89) ___ @@ -429,4 +425,4 @@ AbstractSearchService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ShippingOptionService.md b/docs/content/references/services/classes/ShippingOptionService.md index 81bd2f4adf..ee31311f1c 100644 --- a/docs/content/references/services/classes/ShippingOptionService.md +++ b/docs/content/references/services/classes/ShippingOptionService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L52) +[packages/medusa/src/services/shipping-option.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L54) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L47) +[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L49) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L49) +[packages/medusa/src/services/shipping-option.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L51) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L46) +[packages/medusa/src/services/shipping-option.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L48) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L45) +[packages/medusa/src/services/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L47) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L42) +[packages/medusa/src/services/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L43) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L43) +[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L44) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-option.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L44) +[packages/medusa/src/services/shipping-option.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L46) ___ @@ -142,7 +142,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/shipping-option.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L50) +[packages/medusa/src/services/shipping-option.ts:52](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L52) ## Methods @@ -168,7 +168,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-option.ts:665](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L665) +[packages/medusa/src/services/shipping-option.ts:665](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L665) ___ @@ -207,7 +207,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -233,7 +233,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:405](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L405) +[packages/medusa/src/services/shipping-option.ts:407](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L407) ___ @@ -259,7 +259,7 @@ the resulting shipping method. #### Defined in -[packages/medusa/src/services/shipping-option.ts:268](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L268) +[packages/medusa/src/services/shipping-option.ts:270](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L270) ___ @@ -283,7 +283,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/shipping-option.ts:643](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L643) +[packages/medusa/src/services/shipping-option.ts:643](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L643) ___ @@ -307,7 +307,7 @@ removed shipping methods #### Defined in -[packages/medusa/src/services/shipping-option.ts:248](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L248) +[packages/medusa/src/services/shipping-option.ts:250](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L250) ___ @@ -335,7 +335,7 @@ the price of the shipping option. #### Defined in -[packages/medusa/src/services/shipping-option.ts:724](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L724) +[packages/medusa/src/services/shipping-option.ts:724](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L724) ___ @@ -358,7 +358,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:145](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L145) +[packages/medusa/src/services/shipping-option.ts:147](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L147) ___ @@ -381,7 +381,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-option.ts:161](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L161) +[packages/medusa/src/services/shipping-option.ts:163](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L163) ___ @@ -405,7 +405,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-option.ts:694](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L694) +[packages/medusa/src/services/shipping-option.ts:694](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L694) ___ @@ -433,7 +433,7 @@ the profile document. #### Defined in -[packages/medusa/src/services/shipping-option.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L179) +[packages/medusa/src/services/shipping-option.ts:181](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L181) ___ @@ -457,7 +457,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -484,7 +484,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/shipping-option.ts:529](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L529) +[packages/medusa/src/services/shipping-option.ts:529](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L529) ___ @@ -510,7 +510,7 @@ the resulting shipping method #### Defined in -[packages/medusa/src/services/shipping-option.ts:219](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L219) +[packages/medusa/src/services/shipping-option.ts:221](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L221) ___ @@ -537,7 +537,7 @@ the validated shipping option #### Defined in -[packages/medusa/src/services/shipping-option.ts:356](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L356) +[packages/medusa/src/services/shipping-option.ts:358](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L358) ___ @@ -562,7 +562,7 @@ the validated price #### Defined in -[packages/medusa/src/services/shipping-option.ts:493](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L493) +[packages/medusa/src/services/shipping-option.ts:493](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L493) ___ @@ -587,7 +587,7 @@ a validated shipping requirement #### Defined in -[packages/medusa/src/services/shipping-option.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-option.ts#L79) +[packages/medusa/src/services/shipping-option.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-option.ts#L81) ___ @@ -611,4 +611,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/ShippingProfileService.md b/docs/content/references/services/classes/ShippingProfileService.md index cd25f943cb..0f5a8f8af5 100644 --- a/docs/content/references/services/classes/ShippingProfileService.md +++ b/docs/content/references/services/classes/ShippingProfileService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L45) +[packages/medusa/src/services/shipping-profile.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L47) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L38) +[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L39) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L42) +[packages/medusa/src/services/shipping-profile.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L44) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L40) +[packages/medusa/src/services/shipping-profile.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L42) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L36) +[packages/medusa/src/services/shipping-profile.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L37) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L37) +[packages/medusa/src/services/shipping-profile.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L38) ___ @@ -120,7 +120,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L39) +[packages/medusa/src/services/shipping-profile.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L41) ___ @@ -134,7 +134,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L43) +[packages/medusa/src/services/shipping-profile.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L45) ## Methods @@ -160,7 +160,7 @@ the result of update #### Defined in -[packages/medusa/src/services/shipping-profile.ts:358](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L358) +[packages/medusa/src/services/shipping-profile.ts:353](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L353) ___ @@ -186,7 +186,7 @@ the result of the model update operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:378](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L378) +[packages/medusa/src/services/shipping-profile.ts:373](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L373) ___ @@ -225,7 +225,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -249,7 +249,7 @@ the result of the create operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:247](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L247) +[packages/medusa/src/services/shipping-profile.ts:242](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L242) ___ @@ -267,7 +267,7 @@ the shipping profile #### Defined in -[packages/medusa/src/services/shipping-profile.ts:177](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L177) +[packages/medusa/src/services/shipping-profile.ts:172](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L172) ___ @@ -286,7 +286,7 @@ the shipping profile #### Defined in -[packages/medusa/src/services/shipping-profile.ts:221](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L221) +[packages/medusa/src/services/shipping-profile.ts:216](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L216) ___ @@ -310,7 +310,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:332](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L332) +[packages/medusa/src/services/shipping-profile.ts:327](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L327) ___ @@ -335,7 +335,7 @@ a list of the available shipping options #### Defined in -[packages/medusa/src/services/shipping-profile.ts:398](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L398) +[packages/medusa/src/services/shipping-profile.ts:393](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L393) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L87) +[packages/medusa/src/services/shipping-profile.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L82) ___ @@ -380,7 +380,7 @@ a list of product ids #### Defined in -[packages/medusa/src/services/shipping-profile.ts:468](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L468) +[packages/medusa/src/services/shipping-profile.ts:463](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L463) ___ @@ -403,7 +403,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/shipping-profile.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L75) +[packages/medusa/src/services/shipping-profile.ts:70](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L70) ___ @@ -429,7 +429,7 @@ the profile document. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:139](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L139) +[packages/medusa/src/services/shipping-profile.ts:134](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L134) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[packages/medusa/src/services/shipping-profile.ts:161](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L161) +[packages/medusa/src/services/shipping-profile.ts:156](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L156) ___ @@ -461,7 +461,7 @@ the shipping profile for gift cards #### Defined in -[packages/medusa/src/services/shipping-profile.ts:204](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L204) +[packages/medusa/src/services/shipping-profile.ts:199](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L199) ___ @@ -485,7 +485,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -512,7 +512,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/shipping-profile.ts:275](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/shipping-profile.ts#L275) +[packages/medusa/src/services/shipping-profile.ts:270](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/shipping-profile.ts#L270) ___ @@ -536,4 +536,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/StoreService.md b/docs/content/references/services/classes/StoreService.md index c5673779ff..30adbba792 100644 --- a/docs/content/references/services/classes/StoreService.md +++ b/docs/content/references/services/classes/StoreService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/store.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L32) +[packages/medusa/src/services/store.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L31) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L29) +[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L28) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L30) +[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L29) ___ @@ -88,7 +88,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L25) +[packages/medusa/src/services/store.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L24) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L28) +[packages/medusa/src/services/store.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L27) ___ @@ -112,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/store.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L26) +[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L25) ## Methods @@ -136,7 +136,7 @@ result after update #### Defined in -[packages/medusa/src/services/store.ts:210](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L210) +[packages/medusa/src/services/store.ts:209](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L209) ___ @@ -175,7 +175,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -193,7 +193,7 @@ The store. #### Defined in -[packages/medusa/src/services/store.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L55) +[packages/medusa/src/services/store.ts:54](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L54) ___ @@ -213,7 +213,7 @@ ___ #### Defined in -[packages/medusa/src/services/store.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L104) +[packages/medusa/src/services/store.ts:103](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L103) ___ @@ -237,7 +237,7 @@ result after update #### Defined in -[packages/medusa/src/services/store.ts:254](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L254) +[packages/medusa/src/services/store.ts:253](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L253) ___ @@ -261,7 +261,7 @@ the store #### Defined in -[packages/medusa/src/services/store.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L91) +[packages/medusa/src/services/store.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L90) ___ @@ -285,7 +285,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -309,7 +309,7 @@ resolves to the update result. #### Defined in -[packages/medusa/src/services/store.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/store.ts#L120) +[packages/medusa/src/services/store.ts:119](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/store.ts#L119) ___ @@ -333,4 +333,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/StrategyResolverService.md b/docs/content/references/services/classes/StrategyResolverService.md index d77df192c7..f51472a24d 100644 --- a/docs/content/references/services/classes/StrategyResolverService.md +++ b/docs/content/references/services/classes/StrategyResolverService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L14) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -62,7 +62,7 @@ ___ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L14) ___ @@ -76,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L11) +[packages/medusa/src/services/strategy-resolver.ts:11](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L11) ___ @@ -90,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L12) +[packages/medusa/src/services/strategy-resolver.ts:12](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L12) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/strategy-resolver.ts#L19) +[packages/medusa/src/services/strategy-resolver.ts:19](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/strategy-resolver.ts#L19) ___ @@ -173,7 +173,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -197,4 +197,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SwapService.md b/docs/content/references/services/classes/SwapService.md index d4d708cdaa..ddfea90d5f 100644 --- a/docs/content/references/services/classes/SwapService.md +++ b/docs/content/references/services/classes/SwapService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/swap.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L93) +[packages/medusa/src/services/swap.ts:93](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L93) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L80) +[packages/medusa/src/services/swap.ts:80](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L80) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L91) +[packages/medusa/src/services/swap.ts:91](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L91) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L81) +[packages/medusa/src/services/swap.ts:81](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L81) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L87) +[packages/medusa/src/services/swap.ts:87](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L87) ___ @@ -104,17 +104,17 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L86) +[packages/medusa/src/services/swap.ts:86](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L86) ___ ### lineItemAdjustmentService\_ -• `Protected` `Readonly` **lineItemAdjustmentService\_**: `LineItemAdjustmentService` +• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](LineItemAdjustmentService.md) #### Defined in -[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L90) +[packages/medusa/src/services/swap.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L90) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L85) +[packages/medusa/src/services/swap.ts:85](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L85) ___ @@ -138,7 +138,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L75) +[packages/medusa/src/services/swap.ts:75](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L75) ___ @@ -148,7 +148,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L82) +[packages/medusa/src/services/swap.ts:82](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L82) ___ @@ -158,7 +158,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L89) +[packages/medusa/src/services/swap.ts:89](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L89) ___ @@ -168,7 +168,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L83) +[packages/medusa/src/services/swap.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L83) ___ @@ -178,7 +178,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L88) +[packages/medusa/src/services/swap.ts:88](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L88) ___ @@ -188,7 +188,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L78) +[packages/medusa/src/services/swap.ts:78](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L78) ___ @@ -198,7 +198,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L84) +[packages/medusa/src/services/swap.ts:84](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L84) ___ @@ -212,7 +212,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L76) +[packages/medusa/src/services/swap.ts:76](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L76) ___ @@ -236,7 +236,7 @@ ___ #### Defined in -[packages/medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L63) +[packages/medusa/src/services/swap.ts:63](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L63) ## Methods @@ -275,7 +275,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -301,7 +301,7 @@ the canceled swap. #### Defined in -[packages/medusa/src/services/swap.ts:830](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L830) +[packages/medusa/src/services/swap.ts:830](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L830) ___ @@ -325,7 +325,7 @@ updated swap #### Defined in -[packages/medusa/src/services/swap.ts:1031](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L1031) +[packages/medusa/src/services/swap.ts:1031](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L1031) ___ @@ -359,7 +359,7 @@ the newly created swap #### Defined in -[packages/medusa/src/services/swap.ts:307](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L307) +[packages/medusa/src/services/swap.ts:307](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L307) ___ @@ -387,7 +387,7 @@ the swap with its cart_id prop set to the id of the new cart. #### Defined in -[packages/medusa/src/services/swap.ts:556](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L556) +[packages/medusa/src/services/swap.ts:556](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L556) ___ @@ -413,7 +413,7 @@ the updated swap with new status and fulfillments. #### Defined in -[packages/medusa/src/services/swap.ts:892](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L892) +[packages/medusa/src/services/swap.ts:892](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L892) ___ @@ -440,7 +440,7 @@ the updated swap with new fulfillments and status. #### Defined in -[packages/medusa/src/services/swap.ts:1062](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L1062) +[packages/medusa/src/services/swap.ts:1062](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L1062) ___ @@ -465,7 +465,7 @@ resolves to the updated result. #### Defined in -[packages/medusa/src/services/swap.ts:1140](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L1140) +[packages/medusa/src/services/swap.ts:1140](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L1140) ___ @@ -490,7 +490,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/swap.ts:277](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L277) +[packages/medusa/src/services/swap.ts:277](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L277) ___ @@ -514,7 +514,7 @@ processed swap #### Defined in -[packages/medusa/src/services/swap.ts:400](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L400) +[packages/medusa/src/services/swap.ts:400](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L400) ___ @@ -538,7 +538,7 @@ swap related to the cart #### Defined in -[packages/medusa/src/services/swap.ts:679](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L679) +[packages/medusa/src/services/swap.ts:679](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L679) ___ @@ -563,7 +563,7 @@ the resulting order #### Defined in -[packages/medusa/src/services/swap.ts:1180](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L1180) +[packages/medusa/src/services/swap.ts:1180](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L1180) ___ @@ -588,7 +588,7 @@ the swap #### Defined in -[packages/medusa/src/services/swap.ts:208](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L208) +[packages/medusa/src/services/swap.ts:208](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L208) ___ @@ -613,7 +613,7 @@ the swap #### Defined in -[packages/medusa/src/services/swap.ts:250](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L250) +[packages/medusa/src/services/swap.ts:250](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L250) ___ @@ -637,7 +637,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -661,7 +661,7 @@ transformed find swap config #### Defined in -[packages/medusa/src/services/swap.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L135) +[packages/medusa/src/services/swap.ts:135](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L135) ___ @@ -686,7 +686,7 @@ updated swap record #### Defined in -[packages/medusa/src/services/swap.ts:523](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/swap.ts#L523) +[packages/medusa/src/services/swap.ts:523](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/swap.ts#L523) ___ @@ -710,4 +710,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/SystemPaymentProviderService.md b/docs/content/references/services/classes/SystemPaymentProviderService.md index fba49abcad..5da2d23332 100644 --- a/docs/content/references/services/classes/SystemPaymentProviderService.md +++ b/docs/content/references/services/classes/SystemPaymentProviderService.md @@ -24,7 +24,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L10) +[packages/medusa/src/services/system-payment-provider.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L10) ## Properties @@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L5) +[packages/medusa/src/services/system-payment-provider.ts:5](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L5) ___ @@ -80,7 +80,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L6) +[packages/medusa/src/services/system-payment-provider.ts:6](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L6) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L8) +[packages/medusa/src/services/system-payment-provider.ts:8](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L8) ## Methods @@ -129,7 +129,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -149,7 +149,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L26) +[packages/medusa/src/services/system-payment-provider.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L26) ___ @@ -169,7 +169,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L50) +[packages/medusa/src/services/system-payment-provider.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L50) ___ @@ -189,7 +189,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L42) +[packages/medusa/src/services/system-payment-provider.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L42) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L14) +[packages/medusa/src/services/system-payment-provider.ts:14](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L14) ___ @@ -229,7 +229,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L38) +[packages/medusa/src/services/system-payment-provider.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L38) ___ @@ -249,7 +249,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L22) +[packages/medusa/src/services/system-payment-provider.ts:22](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L22) ___ @@ -269,7 +269,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L18) +[packages/medusa/src/services/system-payment-provider.ts:18](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L18) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L46) +[packages/medusa/src/services/system-payment-provider.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L46) ___ @@ -313,7 +313,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -333,7 +333,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L34) +[packages/medusa/src/services/system-payment-provider.ts:34](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L34) ___ @@ -353,7 +353,7 @@ ___ #### Defined in -[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/system-payment-provider.ts#L30) +[packages/medusa/src/services/system-payment-provider.ts:30](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/system-payment-provider.ts#L30) ___ @@ -377,4 +377,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/TaxProviderService.md b/docs/content/references/services/classes/TaxProviderService.md index 04219d643e..c3bcbbdca2 100644 --- a/docs/content/references/services/classes/TaxProviderService.md +++ b/docs/content/references/services/classes/TaxProviderService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/tax-provider.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L53) +[packages/medusa/src/services/tax-provider.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L53) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L45) +[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L45) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L51) +[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L51) ___ @@ -88,7 +88,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L42) +[packages/medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L42) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L50) +[packages/medusa/src/services/tax-provider.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L50) ___ @@ -108,7 +108,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L48) +[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L48) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L47) +[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L47) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L49) +[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L49) ___ @@ -138,7 +138,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L46) +[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L46) ___ @@ -152,7 +152,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L43) +[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L43) ## Methods @@ -191,7 +191,27 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) + +___ + +### clearLineItemsTaxLines + +▸ **clearLineItemsTaxLines**(`itemIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `itemIds` | `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/medusa/src/services/tax-provider.ts:94](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L94) ___ @@ -211,7 +231,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:94](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L94) +[packages/medusa/src/services/tax-provider.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L104) ___ @@ -237,7 +257,7 @@ the newly created tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:170](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L170) +[packages/medusa/src/services/tax-provider.ts:180](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L180) ___ @@ -262,7 +282,7 @@ the newly created tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L116) +[packages/medusa/src/services/tax-provider.ts:126](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L126) ___ @@ -287,7 +307,7 @@ the cached result or null #### Defined in -[packages/medusa/src/services/tax-provider.ts:457](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L457) +[packages/medusa/src/services/tax-provider.ts:467](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L467) ___ @@ -312,7 +332,7 @@ the cache key to use for the id set #### Defined in -[packages/medusa/src/services/tax-provider.ts:426](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L426) +[packages/medusa/src/services/tax-provider.ts:436](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L436) ___ @@ -338,7 +358,7 @@ the tax rates configured for the shipping option. #### Defined in -[packages/medusa/src/services/tax-provider.ts:379](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L379) +[packages/medusa/src/services/tax-provider.ts:389](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L389) ___ @@ -364,7 +384,7 @@ the tax rates configured for the shipping option. #### Defined in -[packages/medusa/src/services/tax-provider.ts:333](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L333) +[packages/medusa/src/services/tax-provider.ts:343](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L343) ___ @@ -391,7 +411,7 @@ the computed tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:191](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L191) +[packages/medusa/src/services/tax-provider.ts:201](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L201) ___ @@ -420,7 +440,7 @@ the computed tax lines #### Defined in -[packages/medusa/src/services/tax-provider.ts:243](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L243) +[packages/medusa/src/services/tax-provider.ts:253](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L253) ___ @@ -434,7 +454,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L66) +[packages/medusa/src/services/tax-provider.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L66) ___ @@ -454,7 +474,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-provider.ts:478](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L478) +[packages/medusa/src/services/tax-provider.ts:488](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L488) ___ @@ -478,7 +498,7 @@ the region specific tax provider #### Defined in -[packages/medusa/src/services/tax-provider.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L76) +[packages/medusa/src/services/tax-provider.ts:76](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L76) ___ @@ -504,7 +524,7 @@ promise that resolves after the cache has been set #### Defined in -[packages/medusa/src/services/tax-provider.ts:437](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-provider.ts#L437) +[packages/medusa/src/services/tax-provider.ts:447](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-provider.ts#L447) ___ @@ -528,7 +548,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -552,4 +572,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/TaxRateService.md b/docs/content/references/services/classes/TaxRateService.md index fd44cfef21..eefff685ca 100644 --- a/docs/content/references/services/classes/TaxRateService.md +++ b/docs/content/references/services/classes/TaxRateService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService` ↳ **`TaxRateService`** @@ -20,61 +20,107 @@ #### Overrides -BaseService.constructor +TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L28) +[packages/medusa/src/services/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L31) ## Properties -### manager\_ +### \_\_configModule\_\_ -• `Private` **manager\_**: `EntityManager` +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/services/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L22) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +TransactionBaseService.\_\_container\_\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L23) ___ ### productService\_ -• `Private` **productService\_**: [`ProductService`](ProductService.md) +• `Protected` `Readonly` **productService\_**: [`ProductService`](ProductService.md) #### Defined in -[packages/medusa/src/services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L23) +[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L26) ___ ### productTypeService\_ -• `Private` **productTypeService\_**: [`ProductTypeService`](ProductTypeService.md) +• `Protected` `Readonly` **productTypeService\_**: [`ProductTypeService`](ProductTypeService.md) #### Defined in -[packages/medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L24) +[packages/medusa/src/services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L27) ___ ### shippingOptionService\_ -• `Private` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md) +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md) #### Defined in -[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L25) +[packages/medusa/src/services/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L28) ___ ### taxRateRepository\_ -• `Private` **taxRateRepository\_**: typeof `TaxRateRepository` +• `Protected` `Readonly` **taxRateRepository\_**: typeof `TaxRateRepository` #### Defined in -[packages/medusa/src/services/tax-rate.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L26) +[packages/medusa/src/services/tax-rate.ts:29](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L29) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L24) ## Methods @@ -96,7 +142,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:197](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L197) +[packages/medusa/src/services/tax-rate.ts:181](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L181) ___ @@ -118,13 +164,13 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:233](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L233) +[packages/medusa/src/services/tax-rate.ts:217](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L217) ___ ### addToShippingOption -▸ **addToShippingOption**(`id`, `optionIds`, `replace?`): `Promise`<`ShippingTaxRate`\> +▸ **addToShippingOption**(`id`, `optionIds`, `replace?`): `Promise`<`ShippingTaxRate`[]\> #### Parameters @@ -136,11 +182,50 @@ ___ #### Returns -`Promise`<`ShippingTaxRate`\> +`Promise`<`ShippingTaxRate`[]\> #### Defined in -[packages/medusa/src/services/tax-rate.ts:273](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L273) +[packages/medusa/src/services/tax-rate.ts:257](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L257) + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -160,7 +245,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L104) +[packages/medusa/src/services/tax-rate.ts:88](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L88) ___ @@ -180,7 +265,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L135) +[packages/medusa/src/services/tax-rate.ts:119](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L119) ___ @@ -201,7 +286,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L63) +[packages/medusa/src/services/tax-rate.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L47) ___ @@ -222,7 +307,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:74](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L74) +[packages/medusa/src/services/tax-rate.ts:58](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L58) ___ @@ -243,7 +328,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:321](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L321) +[packages/medusa/src/services/tax-rate.ts:305](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L305) ___ @@ -263,7 +348,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:331](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L331) +[packages/medusa/src/services/tax-rate.ts:315](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L315) ___ @@ -284,7 +369,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:143](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L143) +[packages/medusa/src/services/tax-rate.ts:127](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L127) ___ @@ -305,7 +390,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:161](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L161) +[packages/medusa/src/services/tax-rate.ts:145](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L145) ___ @@ -326,7 +411,7 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:179](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L179) +[packages/medusa/src/services/tax-rate.ts:163](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L163) ___ @@ -347,7 +432,31 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L85) +[packages/medusa/src/services/tax-rate.ts:69](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L69) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -368,24 +477,28 @@ ___ #### Defined in -[packages/medusa/src/services/tax-rate.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L120) +[packages/medusa/src/services/tax-rate.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/tax-rate.ts#L104) ___ ### withTransaction -▸ **withTransaction**(`transactionManager`): [`TaxRateService`](TaxRateService.md) +▸ **withTransaction**(`transactionManager?`): [`TaxRateService`](TaxRateService.md) #### Parameters | Name | Type | | :------ | :------ | -| `transactionManager` | `EntityManager` | +| `transactionManager?` | `EntityManager` | #### Returns [`TaxRateService`](TaxRateService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[packages/medusa/src/services/tax-rate.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/tax-rate.ts#L44) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/TotalsService.md b/docs/content/references/services/classes/TotalsService.md index 13ad7fe760..d48b142aae 100644 --- a/docs/content/references/services/classes/TotalsService.md +++ b/docs/content/references/services/classes/TotalsService.md @@ -28,7 +28,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L108) +[packages/medusa/src/services/totals.ts:108](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L108) ## Properties @@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -56,7 +56,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -66,7 +66,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L106) +[packages/medusa/src/services/totals.ts:106](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L106) ___ @@ -80,7 +80,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/totals.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L101) +[packages/medusa/src/services/totals.ts:101](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L101) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L105) +[packages/medusa/src/services/totals.ts:105](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L105) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L104) +[packages/medusa/src/services/totals.ts:104](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L104) ___ @@ -114,7 +114,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/totals.ts:102](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L102) +[packages/medusa/src/services/totals.ts:102](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L102) ## Methods @@ -153,7 +153,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -181,7 +181,7 @@ triples of lineitem, variant and applied discount #### Defined in -[packages/medusa/src/services/totals.ts:647](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L647) +[packages/medusa/src/services/totals.ts:609](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L609) ___ @@ -210,7 +210,7 @@ array of triples of lineitem, variant and applied discount #### Defined in -[packages/medusa/src/services/totals.ts:689](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L689) +[packages/medusa/src/services/totals.ts:651](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L651) ___ @@ -237,7 +237,7 @@ the allocation map for the line items in the cart or order. #### Defined in -[packages/medusa/src/services/totals.ts:433](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L433) +[packages/medusa/src/services/totals.ts:431](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L431) ___ @@ -262,7 +262,7 @@ the tax calculation context #### Defined in -[packages/medusa/src/services/totals.ts:1094](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1094) +[packages/medusa/src/services/totals.ts:1065](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L1065) ___ @@ -287,13 +287,13 @@ the total discounts amount #### Defined in -[packages/medusa/src/services/totals.ts:1064](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1064) +[packages/medusa/src/services/totals.ts:1035](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L1035) ___ ### getGiftCardTotal -▸ **getGiftCardTotal**(`cartOrOrder`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> +▸ **getGiftCardTotal**(`cartOrOrder`, `opts?`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> Gets the gift card amount on a cart or order. @@ -302,6 +302,8 @@ Gets the gift card amount on a cart or order. | Name | Type | Description | | :------ | :------ | :------ | | `cartOrOrder` | `Cart` \| `Order` | the cart or order to get gift card amount for | +| `opts` | `Object` | - | +| `opts.gift_cardable?` | `number` | - | #### Returns @@ -311,7 +313,7 @@ the gift card amount applied to the cart or order #### Defined in -[packages/medusa/src/services/totals.ts:989](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L989) +[packages/medusa/src/services/totals.ts:952](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L952) ___ @@ -336,7 +338,7 @@ the gift card amount applied to the cart or order #### Defined in -[packages/medusa/src/services/totals.ts:972](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L972) +[packages/medusa/src/services/totals.ts:935](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L935) ___ @@ -362,7 +364,7 @@ the allocations that the discount has on the items in the cart or #### Defined in -[packages/medusa/src/services/totals.ts:740](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L740) +[packages/medusa/src/services/totals.ts:702](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L702) ___ @@ -382,7 +384,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:717](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L717) +[packages/medusa/src/services/totals.ts:679](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L679) ___ @@ -403,7 +405,7 @@ ___ #### Defined in -[packages/medusa/src/services/totals.ts:702](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L702) +[packages/medusa/src/services/totals.ts:664](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L664) ___ @@ -428,7 +430,7 @@ the line item refund amount. #### Defined in -[packages/medusa/src/services/totals.ts:525](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L525) +[packages/medusa/src/services/totals.ts:487](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L487) ___ @@ -455,7 +457,7 @@ the line item total #### Defined in -[packages/medusa/src/services/totals.ts:941](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L941) +[packages/medusa/src/services/totals.ts:908](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L908) ___ @@ -483,7 +485,7 @@ the breakdown of the line item totals #### Defined in -[packages/medusa/src/services/totals.ts:786](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L786) +[packages/medusa/src/services/totals.ts:748](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L748) ___ @@ -507,7 +509,7 @@ the total paid amount #### Defined in -[packages/medusa/src/services/totals.ts:158](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L158) +[packages/medusa/src/services/totals.ts:153](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L153) ___ @@ -534,7 +536,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:604](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L604) +[packages/medusa/src/services/totals.ts:566](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L566) ___ @@ -558,7 +560,7 @@ the total refunded amount for an order. #### Defined in -[packages/medusa/src/services/totals.ts:510](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L510) +[packages/medusa/src/services/totals.ts:472](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L472) ___ @@ -585,7 +587,7 @@ An object that breaks down the totals for the shipping method #### Defined in -[packages/medusa/src/services/totals.ts:192](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L192) +[packages/medusa/src/services/totals.ts:187](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L187) ___ @@ -609,7 +611,7 @@ shipping total #### Defined in -[packages/medusa/src/services/totals.ts:317](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L317) +[packages/medusa/src/services/totals.ts:315](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L315) ___ @@ -634,7 +636,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:281](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L281) +[packages/medusa/src/services/totals.ts:279](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L279) ___ @@ -659,7 +661,7 @@ the swap total #### Defined in -[packages/medusa/src/services/totals.ts:173](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L173) +[packages/medusa/src/services/totals.ts:168](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L168) ___ @@ -685,7 +687,7 @@ tax total #### Defined in -[packages/medusa/src/services/totals.ts:344](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L344) +[packages/medusa/src/services/totals.ts:342](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L342) ___ @@ -710,7 +712,7 @@ the calculated subtotal #### Defined in -[packages/medusa/src/services/totals.ts:135](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L135) +[packages/medusa/src/services/totals.ts:130](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L130) ___ @@ -734,7 +736,7 @@ the rounded value #### Defined in -[packages/medusa/src/services/totals.ts:1124](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/totals.ts#L1124) +[packages/medusa/src/services/totals.ts:1095](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/totals.ts#L1095) ___ @@ -758,7 +760,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -782,4 +784,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/classes/UserService.md b/docs/content/references/services/classes/UserService.md index 6025f1a70b..ff2123b0ff 100644 --- a/docs/content/references/services/classes/UserService.md +++ b/docs/content/references/services/classes/UserService.md @@ -26,7 +26,7 @@ TransactionBaseService.constructor #### Defined in -[packages/medusa/src/services/user.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L41) +[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L40) ## Properties @@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L10) +[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10) ___ @@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L9) +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L39) +[packages/medusa/src/services/user.ts:38](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L38) ___ @@ -78,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[packages/medusa/src/services/user.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L36) +[packages/medusa/src/services/user.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L35) ___ @@ -92,7 +92,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[packages/medusa/src/services/user.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L37) +[packages/medusa/src/services/user.ts:36](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L36) ___ @@ -102,7 +102,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L38) +[packages/medusa/src/services/user.ts:37](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L37) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -[packages/medusa/src/services/user.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L29) +[packages/medusa/src/services/user.ts:28](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L28) ## Methods @@ -160,7 +160,7 @@ TransactionBaseService.atomicPhase\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L50) +[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50) ___ @@ -186,7 +186,7 @@ the result of create #### Defined in -[packages/medusa/src/services/user.ts:157](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L157) +[packages/medusa/src/services/user.ts:156](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L156) ___ @@ -210,7 +210,7 @@ the result of the delete operation. #### Defined in -[packages/medusa/src/services/user.ts:237](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L237) +[packages/medusa/src/services/user.ts:236](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L236) ___ @@ -238,7 +238,7 @@ the generated JSON web token #### Defined in -[packages/medusa/src/services/user.ts:293](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L293) +[packages/medusa/src/services/user.ts:292](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L292) ___ @@ -262,7 +262,7 @@ hashed password #### Defined in -[packages/medusa/src/services/user.ts:145](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L145) +[packages/medusa/src/services/user.ts:144](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L144) ___ @@ -285,7 +285,7 @@ the result of the find operation #### Defined in -[packages/medusa/src/services/user.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L54) +[packages/medusa/src/services/user.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L53) ___ @@ -311,7 +311,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L67) +[packages/medusa/src/services/user.ts:66](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L66) ___ @@ -337,7 +337,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L91) +[packages/medusa/src/services/user.ts:90](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L90) ___ @@ -363,7 +363,7 @@ the user document. #### Defined in -[packages/medusa/src/services/user.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L120) +[packages/medusa/src/services/user.ts:119](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L119) ___ @@ -390,7 +390,7 @@ the result of the update operation #### Defined in -[packages/medusa/src/services/user.ts:264](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L264) +[packages/medusa/src/services/user.ts:263](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L263) ___ @@ -414,7 +414,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L31) +[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31) ___ @@ -439,7 +439,7 @@ the result of create #### Defined in -[packages/medusa/src/services/user.ts:191](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/user.ts#L191) +[packages/medusa/src/services/user.ts:190](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/user.ts#L190) ___ @@ -463,4 +463,4 @@ TransactionBaseService.withTransaction #### Defined in -[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/transaction-base-service.ts#L13) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13) diff --git a/docs/content/references/services/index.md b/docs/content/references/services/index.md index ead3f86eed..8bd2f593ac 100644 --- a/docs/content/references/services/index.md +++ b/docs/content/references/services/index.md @@ -19,14 +19,18 @@ - [GiftCardService](classes/GiftCardService.md) - [IdempotencyKeyService](classes/IdempotencyKeyService.md) - [InventoryService](classes/InventoryService.md) +- [LineItemAdjustmentService](classes/LineItemAdjustmentService.md) - [LineItemService](classes/LineItemService.md) - [MiddlewareService](classes/MiddlewareService.md) - [NoteService](classes/NoteService.md) - [NotificationService](classes/NotificationService.md) - [OauthService](classes/OauthService.md) +- [OrderEditItemChangeService](classes/OrderEditItemChangeService.md) - [OrderEditService](classes/OrderEditService.md) - [OrderService](classes/OrderService.md) +- [PaymentCollectionService](classes/PaymentCollectionService.md) - [PaymentProviderService](classes/PaymentProviderService.md) +- [PriceListService](classes/PriceListService.md) - [PricingService](classes/PricingService.md) - [ProductCollectionService](classes/ProductCollectionService.md) - [ProductService](classes/ProductService.md) diff --git a/docs/content/user-guide/price-lists/import.mdx b/docs/content/user-guide/price-lists/import.mdx new file mode 100644 index 0000000000..58f1ed2ba5 --- /dev/null +++ b/docs/content/user-guide/price-lists/import.mdx @@ -0,0 +1,75 @@ +--- +sidebar_position: 3 +--- + +import UiIcon from '@site/src/components/UiIcon'; + +# Import Prices + +In this document, you’ll learn how to import prices into your Medusa store. + +## Overview + +To import prices, you must have the prices in a CSV file. You can see a template of the CSV file during the import process. + +:::caution + +When you import prices into a price list, it removes existing prices and adds new prices. + +::: + +--- + +## Import Prices into a Price List + +To import prices into a price list: + +1. Go to the price list’s details page. +2. In the Prices section, click on the icon. +3. Click on “Import price list” from the dropdown. +4. In the new window: + 1. If you’re unsure of what the CSV file’s format must be like, you can download a template CSV file by clicking the icon. + 2. To upload the CSV file you want to import prices from, either: + 1. Drag and drop the file into the dashed box; + 2. Or click on the dashed box and choose the file you want to import the prices from. + 3. After you upload the CSV file: + 1. You can check the number of prices to be added above the uploaded file’s name. + 2. You can remove the file you choose by clicking the icon. +5. Once you’re done choosing a file to import prices from, click on the Import List button. + +This starts the import process. Based on the number of prices you’re importing, it can take some time. + +:::note + +If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used. + +::: + +### Check Import Status + +To check the status of the import: + +1. Click on the icon at the top right of the page. +2. Find the price import, which should be the latest item on the list. + +If a loading indicator is showing, then the import process is still in progress. + +If the import is done, you should see the text “Import of prices is done.” + +Once the import is done, you should find the news prices on the price list’s details page. + +--- + +## Cancel Import + +:::info + +You can only cancel an unfinished prices import. + +::: + +To cancel a price import: + +1. Click on the icon at the top right of the page. +2. Find the import you want to cancel. +3. Click on the cancel button. \ No newline at end of file diff --git a/docs/content/user-guide/price-lists/index.md b/docs/content/user-guide/price-lists/index.md index 865cf53860..5de7df3827 100644 --- a/docs/content/user-guide/price-lists/index.md +++ b/docs/content/user-guide/price-lists/index.md @@ -27,3 +27,4 @@ In the list, you can see price list details such as the name, description, and s ## Learn More About Price Lists - [Manage a Price List](./manage.mdx) +- [Import Prices](./import.mdx) diff --git a/docs/content/user-guide/products/import.mdx b/docs/content/user-guide/products/import.mdx index 8e71d4e9c8..5aec76bd64 100644 --- a/docs/content/user-guide/products/import.mdx +++ b/docs/content/user-guide/products/import.mdx @@ -23,7 +23,7 @@ To import products: 1. Go to the Products page. 2. Click on Import Products at the top right. 3. In the new window: - 1. If you’re unsure of what the CSV file’s format must be like, you can download a template CSV file by clicking the icon. + 1. If you’re unsure of what the CSV file’s format must be like, you can download a template CSV file by clicking the icon. 2. To upload the CSV file you want to import products from, either: 1. Drag and drop the file into the dashed box; 2. Or click on the dashed box and choose the file you want to import the products from. @@ -32,7 +32,7 @@ To import products: 2. You can remove the file you choose by clicking the icon. 4. Once you’re done choosing a file to import products from, click on the Import List button. -This starts the import status. Based on the number of products you’re importing, it can take some time. +This starts the import process. Based on the number of products you’re importing, it can take some time. :::note diff --git a/packages/medusa-core-utils/CHANGELOG.md b/packages/medusa-core-utils/CHANGELOG.md index 8607545cd9..60c352946d 100644 --- a/packages/medusa-core-utils/CHANGELOG.md +++ b/packages/medusa-core-utils/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## 1.1.33 + +### Patch Changes + +- [`5cb7618a2`](https://github.com/medusajs/medusa/commit/5cb7618a220c420ec2917875f91b8c1f814298f2) Thanks [@olivermrbl](https://github.com/olivermrbl)! - Force bump medusa-core-utils + ## 1.1.32 ### Patch Changes diff --git a/packages/medusa-core-utils/package.json b/packages/medusa-core-utils/package.json index 649ec6e83d..cec2813072 100644 --- a/packages/medusa-core-utils/package.json +++ b/packages/medusa-core-utils/package.json @@ -1,6 +1,6 @@ { "name": "medusa-core-utils", - "version": "1.1.32", + "version": "1.1.33", "description": "Core utils for Medusa", "main": "dist/index.js", "repository": { diff --git a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts b/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts index 0126287668..5dc3cf79b5 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts @@ -109,7 +109,7 @@ import { Type } from "class-transformer" * // must be previously logged in or use api token * medusa.admin.customerGroups.list() * .then(({ customer_groups, limit, offset, count }) => { - * console.log(customer_groups.id); + * console.log(customer_groups.length); * }); * - lang: Shell * label: cURL diff --git a/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts index 84e11460bb..9c850efe18 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts @@ -49,10 +49,10 @@ import { validator } from "../../../../utils/validator" * format: email * billing_address: * description: "The Address to be used for billing purposes." - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/address_fields" * shipping_address: * description: "The Address to be used for shipping." - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/address_fields" * items: * description: The Line Items that have been received. * type: array diff --git a/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts index d1596e37d7..5ec7f5e7a7 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts @@ -47,10 +47,10 @@ import { validator } from "../../../../utils/validator" * format: email * billing_address: * description: "The Address to be used for billing purposes." - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/address_fields" * shipping_address: * description: "The Address to be used for shipping." - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/address_fields" * discounts: * description: "An array of Discount codes to add to the Draft Order." * type: array diff --git a/packages/medusa/src/api/routes/admin/orders/update-order.ts b/packages/medusa/src/api/routes/admin/orders/update-order.ts index 9d3b5e8511..c574d9e249 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-order.ts @@ -35,11 +35,11 @@ import { validator } from "../../../../utils/validator" * billing_address: * description: Billing address * anyOf: - * - $ref: "#/components/schemas/address" + * - $ref: "#/components/schemas/address_fields" * shipping_address: * description: Shipping address * anyOf: - * - $ref: "#/components/schemas/address" + * - $ref: "#/components/schemas/address_fields" * items: * description: The Line Items for the order * type: array diff --git a/packages/medusa/src/api/routes/store/customers/create-address.ts b/packages/medusa/src/api/routes/store/customers/create-address.ts index 87b3f8394f..cf6c34058d 100644 --- a/packages/medusa/src/api/routes/store/customers/create-address.ts +++ b/packages/medusa/src/api/routes/store/customers/create-address.ts @@ -21,8 +21,16 @@ import { EntityManager } from "typeorm" * properties: * address: * description: "The Address to add to the Customer." - * anyOf: - * - $ref: "#/components/schemas/address" + * allOf: + * - $ref: "#/components/schemas/address_fields" + * - type: object + * required: + * - first_name + * - last_name + * - address_1 + * - city + * - country_code + * - postal_code * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/store/customers/update-address.ts b/packages/medusa/src/api/routes/store/customers/update-address.ts index 09173abe21..803b2b0830 100644 --- a/packages/medusa/src/api/routes/store/customers/update-address.ts +++ b/packages/medusa/src/api/routes/store/customers/update-address.ts @@ -18,7 +18,7 @@ import { EntityManager } from "typeorm" * application/json: * schema: * anyOf: - * - $ref: "#/components/schemas/address" + * - $ref: "#/components/schemas/address_fields" * x-codeSamples: * - lang: JavaScript * label: JS Client diff --git a/packages/medusa/src/api/routes/store/customers/update-customer.ts b/packages/medusa/src/api/routes/store/customers/update-customer.ts index 52cc5a7f02..7cc495c550 100644 --- a/packages/medusa/src/api/routes/store/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/update-customer.ts @@ -27,7 +27,7 @@ import { EntityManager } from "typeorm" * billing_address: * description: "The Address to be used for billing purposes." * anyOf: - * - $ref: "#/components/schemas/address" + * - $ref: "#/components/schemas/address_fields" * description: The full billing address object * - type: string * description: The ID of an existing billing address diff --git a/packages/medusa/src/api/routes/store/products/get-product.ts b/packages/medusa/src/api/routes/store/products/get-product.ts index 9fa95b7883..d9adc18b34 100644 --- a/packages/medusa/src/api/routes/store/products/get-product.ts +++ b/packages/medusa/src/api/routes/store/products/get-product.ts @@ -51,7 +51,16 @@ import { validator } from "../../../../utils/validator" * schema: * properties: * product: - * $ref: "#/components/schemas/product" + * allOf: + * - $ref: "#/components/schemas/product" + * - type: object + * properties: + * variants: + * type: array + * items: + * allOf: + * - $ref: "#/components/schemas/product_variant" + * - $ref: "#/components/schemas/product_variant_prices_fields" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/products/list-products.ts b/packages/medusa/src/api/routes/store/products/list-products.ts index 114e744f4a..20d22253f4 100644 --- a/packages/medusa/src/api/routes/store/products/list-products.ts +++ b/packages/medusa/src/api/routes/store/products/list-products.ts @@ -141,7 +141,16 @@ import { IsType } from "../../../../utils/validators/is-type" * products: * type: array * items: - * $ref: "#/components/schemas/product" + * allOf: + * - $ref: "#/components/schemas/product" + * - type: object + * properties: + * variants: + * type: array + * items: + * allOf: + * - $ref: "#/components/schemas/product_variant" + * - $ref: "#/components/schemas/product_variant_prices_fields" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/store/variants/get-variant.ts b/packages/medusa/src/api/routes/store/variants/get-variant.ts index c3c4714b7d..379377a900 100644 --- a/packages/medusa/src/api/routes/store/variants/get-variant.ts +++ b/packages/medusa/src/api/routes/store/variants/get-variant.ts @@ -43,7 +43,9 @@ import { validator } from "../../../../utils/validator" * schema: * properties: * variant: - * $ref: "#/components/schemas/product_variant" + * allOf: + * - $ref: "#/components/schemas/product_variant" + * - $ref: "#/components/schemas/product_variant_prices_fields" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/variants/list-variants.ts b/packages/medusa/src/api/routes/store/variants/list-variants.ts index 1899f82267..614569ff52 100644 --- a/packages/medusa/src/api/routes/store/variants/list-variants.ts +++ b/packages/medusa/src/api/routes/store/variants/list-variants.ts @@ -77,7 +77,9 @@ import { validator } from "../../../../utils/validator" * variants: * type: array * items: - * $ref: "#/components/schemas/product_variant" + * allOf: + * - $ref: "#/components/schemas/product_variant" + * - $ref: "#/components/schemas/product_variant_prices_fields" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/models/address.ts b/packages/medusa/src/models/address.ts index d0883fea6d..8ed36a0164 100644 --- a/packages/medusa/src/models/address.ts +++ b/packages/medusa/src/models/address.ts @@ -1,3 +1,126 @@ +import { + BeforeInsert, + Column, + Entity, + Index, + JoinColumn, + ManyToOne, +} from "typeorm" + +import { Country } from "./country" +import { Customer } from "./customer" +import { DbAwareColumn } from "../utils/db-aware-column" +import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity" +import { generateEntityId } from "../utils/generate-entity-id" + +@Entity() +export class Address extends SoftDeletableEntity { + @Index() + @Column({ type: "varchar", nullable: true }) + customer_id: string | null + + @ManyToOne(() => Customer) + @JoinColumn({ name: "customer_id" }) + customer: Customer | null + + @Column({ type: "varchar", nullable: true }) + company: string | null + + @Column({ type: "varchar", nullable: true }) + first_name: string | null + + @Column({ type: "varchar", nullable: true }) + last_name: string | null + + @Column({ type: "varchar", nullable: true }) + address_1: string | null + + @Column({ type: "varchar", nullable: true }) + address_2: string | null + + @Column({ type: "varchar", nullable: true }) + city: string | null + + @Column({ type: "varchar", nullable: true }) + country_code: string | null + + @ManyToOne(() => Country) + @JoinColumn({ name: "country_code", referencedColumnName: "iso_2" }) + country: Country | null + + @Column({ type: "varchar", nullable: true }) + province: string | null + + @Column({ type: "varchar", nullable: true }) + postal_code: string | null + + @Column({ type: "varchar", nullable: true }) + phone: string | null + + @DbAwareColumn({ type: "jsonb", nullable: true }) + metadata: Record + + @BeforeInsert() + private beforeInsert(): void { + this.id = generateEntityId(this.id, "addr") + } +} + +/** + * @schema address_fields + * title: "Address Fields" + * description: "Address fields used when creating/updating an address." + * x-resourceId: address + * properties: + * company: + * type: string + * description: Company name + * example: Acme + * first_name: + * type: string + * description: First name + * example: Arno + * last_name: + * type: string + * description: Last name + * example: Willms + * address_1: + * type: string + * description: Address line 1 + * example: 14433 Kemmer Court + * address_2: + * type: string + * description: Address line 2 + * example: Suite 369 + * city: + * type: string + * description: City + * example: South Geoffreyview + * country_code: + * type: string + * description: The 2 character ISO code of the country in lower case + * externalDocs: + * url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + * description: See a list of codes. + * example: st + * province: + * type: string + * description: Province + * example: Kentucky + * postal_code: + * type: string + * description: Postal Code + * example: 72093 + * phone: + * type: string + * description: Phone Number + * example: 16128234334802 + * metadata: + * type: object + * description: An optional key-value map with additional details + * example: {car: "white"} + */ + /** * @schema address * title: "Address" @@ -80,72 +203,4 @@ * type: object * description: An optional key-value map with additional details * example: {car: "white"} - */ - -import { - BeforeInsert, - Column, - Entity, - Index, - JoinColumn, - ManyToOne, -} from "typeorm" - -import { Country } from "./country" -import { Customer } from "./customer" -import { DbAwareColumn } from "../utils/db-aware-column" -import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity" -import { generateEntityId } from "../utils/generate-entity-id" - -@Entity() -export class Address extends SoftDeletableEntity { - @Index() - @Column({ type: "varchar", nullable: true }) - customer_id: string | null - - @ManyToOne(() => Customer) - @JoinColumn({ name: "customer_id" }) - customer: Customer | null - - @Column({ type: "varchar", nullable: true }) - company: string | null - - @Column({ type: "varchar", nullable: true }) - first_name: string | null - - @Column({ type: "varchar", nullable: true }) - last_name: string | null - - @Column({ type: "varchar", nullable: true }) - address_1: string | null - - @Column({ type: "varchar", nullable: true }) - address_2: string | null - - @Column({ type: "varchar", nullable: true }) - city: string | null - - @Column({ type: "varchar", nullable: true }) - country_code: string | null - - @ManyToOne(() => Country) - @JoinColumn({ name: "country_code", referencedColumnName: "iso_2" }) - country: Country | null - - @Column({ type: "varchar", nullable: true }) - province: string | null - - @Column({ type: "varchar", nullable: true }) - postal_code: string | null - - @Column({ type: "varchar", nullable: true }) - phone: string | null - - @DbAwareColumn({ type: "jsonb", nullable: true }) - metadata: Record - - @BeforeInsert() - private beforeInsert(): void { - this.id = generateEntityId(this.id, "addr") - } -} + */ \ No newline at end of file diff --git a/packages/medusa/src/models/product-variant.ts b/packages/medusa/src/models/product-variant.ts index 2045e6c648..66f5942432 100644 --- a/packages/medusa/src/models/product-variant.ts +++ b/packages/medusa/src/models/product-variant.ts @@ -216,3 +216,44 @@ export class ProductVariant extends SoftDeletableEntity { * description: An optional key-value map with additional details * example: {car: "white"} */ + +/** + * @schema product_variant_prices_fields + * title: "Product Variant Prices Fields" + * description: "Product Variants Prices Fields that are only available in some requests." + * x-resourceId: product_variant_prices_fields + * properties: + * original_price: + * type: number + * description: The original price of the variant without any discounted prices applied. + * calculated_price: + * type: number + * description: The calculated price of the variant. Can be a discounted price. + * original_price_incl_tax: + * type: number + * description: The original price of the variant including taxes. + * calculated_price_incl_tax: + * type: number + * description: The calculated price of the variant including taxes. + * original_tax: + * type: number + * description: The taxes applied on the original price. + * calculated_tax: + * type: number + * description: The taxes applied on the calculated price. + * tax_rates: + * type: array + * description: An array of applied tax rates + * items: + * type: object + * properties: + * rate: + * type: number + * description: The tax rate value + * name: + * type: string + * description: The name of the tax rate + * code: + * type: string + * description: The code of the tax rate + */ \ No newline at end of file diff --git a/scripts/doc-change-release.js b/scripts/doc-change-release.js index a10845c7ff..9e209ba3e8 100644 --- a/scripts/doc-change-release.js +++ b/scripts/doc-change-release.js @@ -22,7 +22,7 @@ async function main () { per_page: 1 }) - if (commitResponse.data.length && dateDiffInDays(commitResponse.data[0].commit.committer.date, new Date()) < 6) { + if (commitResponse.data.length && dateDiffInDays(new Date(commitResponse.data[0].commit.committer.date), new Date()) < 6) { console.log("File was edited less than 6 days ago. Expiry canceled."); return; } diff --git a/www/docs/announcement.json b/www/docs/announcement.json index 9e26dfeeb6..4194039292 100644 --- a/www/docs/announcement.json +++ b/www/docs/announcement.json @@ -1 +1 @@ -{} \ No newline at end of file +{"id":"release-v1-5-0","content":"New Release! Version v1.5.0 of Medusa is out now! Read all about it here.","backgroundColor":"#7C53FF","textColor":"#fff","isCloseable":false} diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 86a81112a7..a00da61c3e 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -204,6 +204,11 @@ module.exports = { id: "advanced/storefront/how-to-implement-checkout-flow", label: "Implement Checkout" }, + { + type: "doc", + id: "advanced/storefront/use-sales-channels", + label: "Use SalesChannels APIs" + }, ] }, { @@ -215,6 +220,11 @@ module.exports = { id: "advanced/admin/import-products", label: "Import Products" }, + { + type: "doc", + id: "advanced/admin/import-prices", + label: "Import Prices" + }, { type: "doc", id: "advanced/backend/taxes/manual-calculation", @@ -627,11 +637,21 @@ module.exports = { id: "references/js-client/classes/AdminAuthResource", label: "auth", }, + { + type: "doc", + id: "references/js-client/classes/AdminBatchJobsResource", + label: "batchJobs", + }, { type: "doc", id: "references/js-client/classes/AdminCollectionsResource", label: "collections", }, + { + type: "doc", + id: "references/js-client/classes/AdminCurrenciesResource", + label: "currencies", + }, { type: "doc", id: "references/js-client/classes/AdminCustomerGroupsResource", @@ -677,6 +697,11 @@ module.exports = { id: "references/js-client/classes/AdminOrdersResource", label: "orders", }, + { + type: "doc", + id: "references/js-client/classes/AdminOrderEditsResource", + label: "orderEdits", + }, { type: "doc", id: "references/js-client/classes/AdminPriceListResource", @@ -712,6 +737,11 @@ module.exports = { id: "references/js-client/classes/AdminReturnsResource", label: "returns", }, + { + type: "doc", + id: "references/js-client/classes/AdminSalesChannelsResource", + label: "salesChannels", + }, { type: "doc", id: "references/js-client/classes/AdminShippingOptionsResource", @@ -811,6 +841,11 @@ module.exports = { id: "references/js-client/classes/OrdersResource", label: "orders", }, + { + type: "doc", + id: "references/js-client/classes/OrderEditsResource", + label: "orderEdits", + }, { type: "doc", id: "references/js-client/classes/PaymentMethodsResource", @@ -840,7 +875,7 @@ module.exports = { { type: "doc", id: "references/js-client/classes/ReturnReasonsResource", - label: "returnReason", + label: "returnReasons", }, { type: "doc",