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/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/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/www/docs/sidebars.js b/www/docs/sidebars.js index bbf5a5f779..a00da61c3e 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -637,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", @@ -687,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", @@ -722,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", @@ -821,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", @@ -850,7 +875,7 @@ module.exports = { { type: "doc", id: "references/js-client/classes/ReturnReasonsResource", - label: "returnReason", + label: "returnReasons", }, { type: "doc",