diff --git a/docs/content/references/js-client/classes/AddressesResource.md b/docs/content/references/js-client/classes/AddressesResource.md index d68063fece..47771aab10 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/a4dd26e13/packages/medusa-js/src/resources/addresses.ts#L16) +[medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/addresses.ts#L30) +[medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/addresses.ts#L45) +[medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/105c68929/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 22db9dae10..9aaf60b022 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:34](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L34) +[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L37) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L35) +[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L38) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L40) +[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L43) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L39) +[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L42) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L37) +[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L40) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L36) +[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L39) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L38) +[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L41) ___ @@ -84,7 +84,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L41) +[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L44) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L42) +[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L45) ___ @@ -104,7 +104,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L43) +[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L46) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L44) +[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L47) ___ @@ -124,7 +124,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L61) +[medusa-js/src/resources/admin/index.ts:65](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L65) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L52) +[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L55) ___ @@ -144,7 +144,27 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L51) +[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L54) + +___ + +### paymentCollections + +• **paymentCollections**: [`AdminPaymentCollectionsResource`](AdminPaymentCollectionsResource.md) + +#### Defined in + +[medusa-js/src/resources/admin/index.ts:68](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L68) + +___ + +### payments + +• **payments**: [`AdminPaymentsResource`](AdminPaymentsResource.md) + +#### Defined in + +[medusa-js/src/resources/admin/index.ts:69](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L69) ___ @@ -154,7 +174,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L45) +[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L48) ___ @@ -164,7 +184,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L47) +[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L50) ___ @@ -174,7 +194,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L48) +[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L51) ___ @@ -184,7 +204,17 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L46) +[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L49) + +___ + +### publishableApiKeys + +• **publishableApiKeys**: [`AdminPublishableApiKeyResource`](AdminPublishableApiKeyResource.md) + +#### Defined in + +[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L56) ___ @@ -194,7 +224,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L60) +[medusa-js/src/resources/admin/index.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L64) ___ @@ -204,7 +234,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L53) +[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L57) ___ @@ -214,7 +244,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L50) +[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L53) ___ @@ -224,7 +254,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L55) +[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L59) ___ @@ -234,7 +264,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L59) +[medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L63) ___ @@ -244,7 +274,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L57) +[medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L61) ___ @@ -254,7 +284,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L58) +[medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L62) ___ @@ -264,7 +294,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L56) +[medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L60) ___ @@ -274,7 +304,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L62) +[medusa-js/src/resources/admin/index.ts:66](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L66) ___ @@ -284,7 +314,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L63) +[medusa-js/src/resources/admin/index.ts:67](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L67) ___ @@ -294,7 +324,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L49) +[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L52) ___ @@ -304,4 +334,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/index.ts#L54) +[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/index.ts#L58) diff --git a/docs/content/references/js-client/classes/AdminAuthResource.md b/docs/content/references/js-client/classes/AdminAuthResource.md index 4067b25111..2c8e2fde0e 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/a4dd26e13/packages/medusa-js/src/resources/admin/auth.ts#L37) +[medusa-js/src/resources/admin/auth.ts:37](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/auth.ts#L24) +[medusa-js/src/resources/admin/auth.ts:24](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/auth.ts#L12) +[medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/105c68929/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 a6ecaf9f51..374d90b970 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/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/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 00ba02a8c7..c90a2b997a 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/a4dd26e13/packages/medusa-js/src/resources/admin/collections.ts#L100) +[medusa-js/src/resources/admin/collections.ts:100](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/collections.ts#L22) +[medusa-js/src/resources/admin/collections.ts:22](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/collections.ts#L52) +[medusa-js/src/resources/admin/collections.ts:52](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/collections.ts#L80) +[medusa-js/src/resources/admin/collections.ts:80](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/collections.ts#L115) +[medusa-js/src/resources/admin/collections.ts:115](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/collections.ts#L66) +[medusa-js/src/resources/admin/collections.ts:66](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/collections.ts#L37) +[medusa-js/src/resources/admin/collections.ts:37](https://github.com/medusajs/medusa/blob/105c68929/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 index ba0b9653e2..222fcdf7a8 100644 --- a/docs/content/references/js-client/classes/AdminCurrenciesResource.md +++ b/docs/content/references/js-client/classes/AdminCurrenciesResource.md @@ -33,7 +33,7 @@ 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/a4dd26e13/packages/medusa-js/src/resources/admin/currencies.ts#L20) +[medusa-js/src/resources/admin/currencies.ts:20](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/currencies.ts#L20) ___ @@ -63,4 +63,4 @@ the updated currency. #### Defined in -[medusa-js/src/resources/admin/currencies.ts:43](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/currencies.ts#L43) +[medusa-js/src/resources/admin/currencies.ts:43](https://github.com/medusajs/medusa/blob/105c68929/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 4f7da06003..cc8625f403 100644 --- a/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md +++ b/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md @@ -28,7 +28,7 @@ Add multiple customers to a customer group. #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/customer-groups.ts#L112) ___ @@ -51,7 +51,7 @@ Create a customer group. #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/customer-groups.ts#L26) ___ @@ -74,7 +74,7 @@ Deletes a customer group. #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/customer-groups.ts#L77) ___ @@ -97,7 +97,7 @@ Lists customer groups. #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/customer-groups.ts#L91) ___ @@ -121,7 +121,7 @@ List and count customers that belong to provided customer groups. #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/customer-groups.ts#L144) ___ @@ -145,7 +145,7 @@ Remove multiple customers from a customer group. #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/customer-groups.ts#L128) ___ @@ -169,7 +169,7 @@ Retrieves a customer group. #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/customer-groups.ts#L41) ___ @@ -193,4 +193,4 @@ Updates a customer group #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 199813fcb0..d7da070e0a 100644 --- a/docs/content/references/js-client/classes/AdminCustomersResource.md +++ b/docs/content/references/js-client/classes/AdminCustomersResource.md @@ -27,7 +27,7 @@ Creates a customer #### Defined in -[medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/customers.ts#L18) +[medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/customers.ts#L18) ___ @@ -50,7 +50,7 @@ Lists customers #### Defined in -[medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/customers.ts#L59) +[medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/customers.ts#L59) ___ @@ -73,7 +73,7 @@ Retrieves a customer #### Defined in -[medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/customers.ts#L46) +[medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/customers.ts#L46) ___ @@ -97,4 +97,4 @@ Updates a customer #### Defined in -[medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/customers.ts#L32) +[medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/105c68929/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 4b6f73884b..2f0fcb4204 100644 --- a/docs/content/references/js-client/classes/AdminDiscountsResource.md +++ b/docs/content/references/js-client/classes/AdminDiscountsResource.md @@ -32,7 +32,7 @@ Add a batch of items to a discount condition #### Defined in -[medusa-js/src/resources/admin/discounts.ts:218](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L218) +[medusa-js/src/resources/admin/discounts.ts:218](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L218) ___ @@ -58,7 +58,7 @@ Adds region to discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:27](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L27) +[medusa-js/src/resources/admin/discounts.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L27) ___ @@ -83,7 +83,7 @@ Creates discounts #### Defined in -[medusa-js/src/resources/admin/discounts.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L39) +[medusa-js/src/resources/admin/discounts.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L39) ___ @@ -110,7 +110,7 @@ creates a discount condition #### Defined in -[medusa-js/src/resources/admin/discounts.ts:148](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L148) +[medusa-js/src/resources/admin/discounts.ts:148](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L148) ___ @@ -136,7 +136,7 @@ Creates a dynamic discount code #### Defined in -[medusa-js/src/resources/admin/discounts.ts:62](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L62) +[medusa-js/src/resources/admin/discounts.ts:62](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L62) ___ @@ -161,7 +161,7 @@ Deletes a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:74](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L74) +[medusa-js/src/resources/admin/discounts.ts:74](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L74) ___ @@ -187,7 +187,7 @@ Removes a condition from a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:187](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L187) +[medusa-js/src/resources/admin/discounts.ts:187](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L187) ___ @@ -214,7 +214,7 @@ Delete a batch of items from a discount condition #### Defined in -[medusa-js/src/resources/admin/discounts.ts:238](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L238) +[medusa-js/src/resources/admin/discounts.ts:238](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L238) ___ @@ -240,7 +240,7 @@ Deletes a dynamic discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:85](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L85) +[medusa-js/src/resources/admin/discounts.ts:85](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L85) ___ @@ -267,7 +267,7 @@ Gets a condition from a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:199](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L199) +[medusa-js/src/resources/admin/discounts.ts:199](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L199) ___ @@ -292,7 +292,7 @@ Lists discounts #### Defined in -[medusa-js/src/resources/admin/discounts.ts:119](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L119) +[medusa-js/src/resources/admin/discounts.ts:119](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L119) ___ @@ -318,7 +318,7 @@ Removes a region from a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:136](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L136) +[medusa-js/src/resources/admin/discounts.ts:136](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L136) ___ @@ -343,7 +343,7 @@ Retrieves a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:97](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L97) +[medusa-js/src/resources/admin/discounts.ts:97](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L97) ___ @@ -368,7 +368,7 @@ Retrieves a discount by code #### Defined in -[medusa-js/src/resources/admin/discounts.ts:108](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L108) +[medusa-js/src/resources/admin/discounts.ts:108](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L108) ___ @@ -394,7 +394,7 @@ Updates discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:50](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L50) +[medusa-js/src/resources/admin/discounts.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L50) ___ @@ -422,4 +422,4 @@ Updates a discount condition #### Defined in -[medusa-js/src/resources/admin/discounts.ts:167](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/discounts.ts#L167) +[medusa-js/src/resources/admin/discounts.ts:167](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/discounts.ts#L167) diff --git a/docs/content/references/js-client/classes/AdminDraftOrdersResource.md b/docs/content/references/js-client/classes/AdminDraftOrdersResource.md index 7bb2896063..7c3ecf74e3 100644 --- a/docs/content/references/js-client/classes/AdminDraftOrdersResource.md +++ b/docs/content/references/js-client/classes/AdminDraftOrdersResource.md @@ -30,7 +30,7 @@ Add line item to draft order #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:30](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/draft-orders.ts#L30) ___ @@ -55,7 +55,7 @@ Creates a draft order #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:20](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/draft-orders.ts#L20) +[medusa-js/src/resources/admin/draft-orders.ts:20](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/draft-orders.ts#L20) ___ @@ -80,7 +80,7 @@ Delete draft order #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:42](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/draft-orders.ts#L42) ___ @@ -105,7 +105,7 @@ Lists draft orders #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:76](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/draft-orders.ts#L76) ___ @@ -130,7 +130,7 @@ Mark a draft order as paid #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:93](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/draft-orders.ts#L93) ___ @@ -156,7 +156,7 @@ Remove line item #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:53](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/draft-orders.ts#L53) ___ @@ -181,7 +181,7 @@ Retrieves a draft order #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:65](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/draft-orders.ts#L65) ___ @@ -207,7 +207,7 @@ Update draft order #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:104](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/draft-orders.ts#L104) ___ @@ -234,4 +234,4 @@ Update draft order line item #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:116](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 99b644cbb5..f98ec82671 100644 --- a/docs/content/references/js-client/classes/AdminGiftCardsResource.md +++ b/docs/content/references/js-client/classes/AdminGiftCardsResource.md @@ -29,7 +29,7 @@ Creates a gift card #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/gift-cards.ts#L17) ___ @@ -54,7 +54,7 @@ Deletes a gift card #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/gift-cards.ts#L40) ___ @@ -79,7 +79,7 @@ Lists gift cards #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/gift-cards.ts#L62) ___ @@ -104,7 +104,7 @@ Deletes a gift card #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/gift-cards.ts#L51) ___ @@ -130,4 +130,4 @@ Updates a gift card #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 71399e70a7..62bfd9a472 100644 --- a/docs/content/references/js-client/classes/AdminInvitesResource.md +++ b/docs/content/references/js-client/classes/AdminInvitesResource.md @@ -25,7 +25,7 @@ #### Defined in -[medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/invites.ts#L10) +[medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/invites.ts#L10) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/invites.ts#L18) +[medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/invites.ts#L18) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/invites.ts#L26) +[medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/invites.ts#L26) ___ @@ -87,7 +87,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/invites.ts#L34) +[medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/invites.ts#L41) +[medusa-js/src/resources/admin/invites.ts:41](https://github.com/medusajs/medusa/blob/105c68929/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 34c2278f4a..3e86232df8 100644 --- a/docs/content/references/js-client/classes/AdminNotesResource.md +++ b/docs/content/references/js-client/classes/AdminNotesResource.md @@ -25,7 +25,7 @@ #### Defined in -[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/notes.ts#L14) +[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/notes.ts#L14) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/notes.ts#L31) +[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/notes.ts#L31) ___ @@ -67,7 +67,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/notes.ts#L47) +[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/notes.ts#L47) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/notes.ts#L39) +[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/notes.ts#L39) ___ @@ -110,4 +110,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/notes.ts#L22) +[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/105c68929/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 da842878a3..0e915f05ae 100644 --- a/docs/content/references/js-client/classes/AdminNotificationsResource.md +++ b/docs/content/references/js-client/classes/AdminNotificationsResource.md @@ -25,7 +25,7 @@ #### Defined in -[medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/notifications.ts#L12) +[medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/notifications.ts#L12) ___ @@ -47,4 +47,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/notifications.ts#L26) +[medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/105c68929/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 index 0ee12e6fc2..7456c2b5fe 100644 --- a/docs/content/references/js-client/classes/AdminOrderEditsResource.md +++ b/docs/content/references/js-client/classes/AdminOrderEditsResource.md @@ -26,7 +26,7 @@ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:72](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L72) +[medusa-js/src/resources/admin/order-edits.ts:72](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L72) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:98](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L98) +[medusa-js/src/resources/admin/order-edits.ts:98](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L98) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:106](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L106) +[medusa-js/src/resources/admin/order-edits.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L106) ___ @@ -89,7 +89,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:47](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L47) +[medusa-js/src/resources/admin/order-edits.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L47) ___ @@ -110,7 +110,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:64](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L64) +[medusa-js/src/resources/admin/order-edits.ts:64](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L64) ___ @@ -132,7 +132,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:81](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L81) +[medusa-js/src/resources/admin/order-edits.ts:81](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L81) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:33](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L33) +[medusa-js/src/resources/admin/order-edits.ts:33](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L33) ___ @@ -175,7 +175,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:124](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L124) +[medusa-js/src/resources/admin/order-edits.ts:124](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L124) ___ @@ -196,7 +196,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:90](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L90) +[medusa-js/src/resources/admin/order-edits.ts:90](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L90) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:18](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L18) +[medusa-js/src/resources/admin/order-edits.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L18) ___ @@ -240,7 +240,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:55](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L55) +[medusa-js/src/resources/admin/order-edits.ts:55](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L55) ___ @@ -263,4 +263,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:114](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/order-edits.ts#L114) +[medusa-js/src/resources/admin/order-edits.ts:114](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/order-edits.ts#L114) diff --git a/docs/content/references/js-client/classes/AdminOrdersResource.md b/docs/content/references/js-client/classes/AdminOrdersResource.md index 8babe608dd..cbda96e7ce 100644 --- a/docs/content/references/js-client/classes/AdminOrdersResource.md +++ b/docs/content/references/js-client/classes/AdminOrdersResource.md @@ -26,7 +26,7 @@ #### Defined in -[medusa-js/src/resources/admin/orders.ts:152](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L152) +[medusa-js/src/resources/admin/orders.ts:152](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L152) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L161) +[medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L161) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L144) +[medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L144) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:225](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L225) +[medusa-js/src/resources/admin/orders.ts:225](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L225) ___ @@ -113,7 +113,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:116](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L116) +[medusa-js/src/resources/admin/orders.ts:116](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L116) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:97](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L97) +[medusa-js/src/resources/admin/orders.ts:97](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L97) ___ @@ -157,7 +157,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:178](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L178) +[medusa-js/src/resources/admin/orders.ts:178](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L178) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:106](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L106) +[medusa-js/src/resources/admin/orders.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L106) ___ @@ -201,7 +201,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L71) +[medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L71) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L63) +[medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L63) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:216](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L216) +[medusa-js/src/resources/admin/orders.ts:216](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L216) ___ @@ -267,7 +267,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:254](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L254) +[medusa-js/src/resources/admin/orders.ts:254](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L254) ___ @@ -289,7 +289,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:88](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L88) +[medusa-js/src/resources/admin/orders.ts:88](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L88) ___ @@ -311,7 +311,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:126](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L126) +[medusa-js/src/resources/admin/orders.ts:126](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L126) ___ @@ -333,7 +333,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:169](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L169) +[medusa-js/src/resources/admin/orders.ts:169](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L169) ___ @@ -356,7 +356,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:197](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L197) +[medusa-js/src/resources/admin/orders.ts:197](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L197) ___ @@ -379,7 +379,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:244](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L244) +[medusa-js/src/resources/admin/orders.ts:244](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L244) ___ @@ -402,7 +402,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:187](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L187) +[medusa-js/src/resources/admin/orders.ts:187](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L187) ___ @@ -423,7 +423,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:49](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L49) +[medusa-js/src/resources/admin/orders.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L49) ___ @@ -445,7 +445,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:207](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L207) +[medusa-js/src/resources/admin/orders.ts:207](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L207) ___ @@ -467,7 +467,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:79](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L79) +[medusa-js/src/resources/admin/orders.ts:79](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L79) ___ @@ -489,7 +489,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:135](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L135) +[medusa-js/src/resources/admin/orders.ts:135](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L135) ___ @@ -511,7 +511,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:34](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L34) +[medusa-js/src/resources/admin/orders.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L34) ___ @@ -533,7 +533,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L25) +[medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L25) ___ @@ -556,4 +556,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/orders.ts:234](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/orders.ts#L234) +[medusa-js/src/resources/admin/orders.ts:234](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/orders.ts#L234) diff --git a/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md b/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md new file mode 100644 index 0000000000..a6f6377c6c --- /dev/null +++ b/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md @@ -0,0 +1,93 @@ +# Class: AdminPaymentCollectionsResource + +## Hierarchy + +- `default` + + ↳ **`AdminPaymentCollectionsResource`** + +## Methods + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-15.md#adminpaymentcollectiondeleteres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-15.md#adminpaymentcollectiondeleteres)\> + +#### Defined in + +[medusa-js/src/resources/admin/payment-collections.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payment-collections.ts#L36) + +___ + +### markAsAuthorized + +▸ **markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionRes`](../modules/internal-15.md#adminpaymentcollectionres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionRes`](../modules/internal-15.md#adminpaymentcollectionres)\> + +#### Defined in + +[medusa-js/src/resources/admin/payment-collections.ts:44](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payment-collections.ts#L44) + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionRes`](../modules/internal-15.md#adminpaymentcollectionres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `query?` | [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionRes`](../modules/internal-15.md#adminpaymentcollectionres)\> + +#### Defined in + +[medusa-js/src/resources/admin/payment-collections.ts:12](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payment-collections.ts#L12) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionRes`](../modules/internal-15.md#adminpaymentcollectionres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminUpdatePaymentCollectionRequest`](internal-15.AdminUpdatePaymentCollectionRequest.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionRes`](../modules/internal-15.md#adminpaymentcollectionres)\> + +#### Defined in + +[medusa-js/src/resources/admin/payment-collections.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payment-collections.ts#L27) diff --git a/docs/content/references/js-client/classes/AdminPaymentsResource.md b/docs/content/references/js-client/classes/AdminPaymentsResource.md new file mode 100644 index 0000000000..3da504f9ed --- /dev/null +++ b/docs/content/references/js-client/classes/AdminPaymentsResource.md @@ -0,0 +1,72 @@ +# Class: AdminPaymentsResource + +## Hierarchy + +- `default` + + ↳ **`AdminPaymentsResource`** + +## Methods + +### capturePayment + +▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> + +#### Defined in + +[medusa-js/src/resources/admin/payments.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payments.ts#L27) + +___ + +### refundPayment + +▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRefundRes`](../modules/internal-16.md#adminrefundres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostPaymentRefundsReq`](internal-16.AdminPostPaymentRefundsReq.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRefundRes`](../modules/internal-16.md#adminrefundres)\> + +#### Defined in + +[medusa-js/src/resources/admin/payments.ts:35](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payments.ts#L35) + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `query?` | [`GetPaymentsParams`](internal-16.GetPaymentsParams.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> + +#### Defined in + +[medusa-js/src/resources/admin/payments.ts:12](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/payments.ts#L12) diff --git a/docs/content/references/js-client/classes/AdminPriceListResource.md b/docs/content/references/js-client/classes/AdminPriceListResource.md index 80f3968b56..79205119cc 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-15.md#adminpricelistres)\> +▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-15.AdminPostPriceListPricesPricesReq.md) | +| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-17.AdminPostPriceListPricesPricesReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/price-lists.ts#L80) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostPriceListsPriceListReq`](internal-15.AdminPostPriceListsPriceListReq.md) | +| `payload` | [`AdminPostPriceListsPriceListReq`](internal-17.AdminPostPriceListsPriceListReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/price-lists.ts#L35) ___ ### deletePrices -▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> +▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-15.AdminDeletePriceListPricesPricesReq.md) | +| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-17.AdminDeletePriceListPricesPricesReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/price-lists.ts#L89) ___ ### deleteProductPrices -▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> +▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> #### Parameters @@ -108,17 +108,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/price-lists.ts#L98) ___ ### deleteVariantPrices -▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> +▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> #### Parameters @@ -130,32 +130,32 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-15.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/price-lists.ts#L107) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-15.md#adminpricelistslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-17.md#adminpricelistslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetPriceListPaginationParams`](internal-15.AdminGetPriceListPaginationParams.md) | +| `query?` | [`AdminGetPriceListPaginationParams`](internal-17.AdminGetPriceListPaginationParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-15.md#adminpricelistslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-17.md#adminpricelistslistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/price-lists.ts#L51) ___ @@ -168,7 +168,7 @@ ___ | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-15.AdminGetPriceListsPriceListProductsParams.md) | +| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-17.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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/price-lists.ts#L65) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> #### Parameters @@ -194,30 +194,30 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/price-lists.ts#L43) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-15.AdminPostPriceListsPriceListPriceListReq.md) | +| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-17.AdminPostPriceListsPriceListPriceListReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-15.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 a226307b9b..aa3bba1705 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-16.md#adminproducttagslistres)\> +▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-18.md#adminproducttagslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductTagsParams`](internal-16.AdminGetProductTagsParams.md) | +| `query?` | [`AdminGetProductTagsParams`](internal-18.AdminGetProductTagsParams.md) | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-16.md#adminproducttagslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-18.md#adminproducttagslistres)\> #### Defined in -[medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 241424c7de..dbb974f7e0 100644 --- a/docs/content/references/js-client/classes/AdminProductTypesResource.md +++ b/docs/content/references/js-client/classes/AdminProductTypesResource.md @@ -10,19 +10,19 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-17.md#adminproducttypeslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-19.md#adminproducttypeslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductTypesParams`](internal-17.AdminGetProductTypesParams.md) | +| `query?` | [`AdminGetProductTypesParams`](internal-19.AdminGetProductTypesParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-17.md#adminproducttypeslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-19.md#adminproducttypeslistres)\> #### Defined in -[medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 c85cdb196d..8523a3ac1a 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-18.md#adminproductsres)\> +▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductOptionsReq`](internal-18.AdminPostProductsProductOptionsReq.md) | +| `payload` | [`AdminPostProductsProductOptionsReq`](internal-20.AdminPostProductsProductOptionsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:124](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L124) +[medusa-js/src/resources/admin/products.ts:124](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L124) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostProductsReq`](internal-18.AdminPostProductsReq.md) | +| `payload` | [`AdminPostProductsReq`](internal-20.AdminPostProductsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L23) +[medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L23) ___ ### createVariant -▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductVariantsReq`](internal-18.AdminPostProductsProductVariantsReq.md) | +| `payload` | [`AdminPostProductsProductVariantsReq`](internal-20.AdminPostProductsProductVariantsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:96](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L96) +[medusa-js/src/resources/admin/products.ts:96](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L96) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-18.md#adminproductsdeleteres)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-20.md#adminproductsdeleteres)\> #### Parameters @@ -86,17 +86,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-18.md#adminproductsdeleteres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-20.md#adminproductsdeleteres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L48) +[medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L48) ___ ### deleteOption -▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-18.md#adminproductsdeleteoptionres)\> +▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-20.md#adminproductsdeleteoptionres)\> #### Parameters @@ -108,17 +108,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-18.md#adminproductsdeleteoptionres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-20.md#adminproductsdeleteoptionres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:143](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L143) +[medusa-js/src/resources/admin/products.ts:143](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L143) ___ ### deleteVariant -▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-18.md#adminproductsdeletevariantres)\> +▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-20.md#adminproductsdeletevariantres)\> #### Parameters @@ -130,38 +130,38 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-18.md#adminproductsdeletevariantres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-20.md#adminproductsdeletevariantres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:115](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L115) +[medusa-js/src/resources/admin/products.ts:115](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L115) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-18.md#adminproductslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-20.md#adminproductslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductsParams`](internal-18.AdminGetProductsParams.md) | +| `query?` | [`AdminGetProductsParams`](internal-20.AdminGetProductsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-18.md#adminproductslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-20.md#adminproductslistres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L56) +[medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L56) ___ ### listTags -▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-18.md#adminproductslisttagsres)\> +▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-20.md#adminproductslisttagsres)\> #### Parameters @@ -171,17 +171,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-18.md#adminproductslisttagsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-20.md#adminproductslisttagsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:80](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L80) +[medusa-js/src/resources/admin/products.ts:80](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L80) ___ ### listTypes -▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-18.md#adminproductslisttypesres)\> +▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-20.md#adminproductslisttypesres)\> **`Deprecated`** @@ -195,17 +195,17 @@ Use [list](AdminProductTypesResource.md#list) instead. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-18.md#adminproductslisttypesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-20.md#adminproductslisttypesres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:73](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L73) +[medusa-js/src/resources/admin/products.ts:73](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L73) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Parameters @@ -216,61 +216,61 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L31) +[medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L31) ___ ### setMetadata -▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductMetadataReq`](internal-18.AdminPostProductsProductMetadataReq.md) | +| `payload` | [`AdminPostProductsProductMetadataReq`](internal-20.AdminPostProductsProductMetadataReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:87](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L87) +[medusa-js/src/resources/admin/products.ts:87](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L87) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductReq`](internal-18.AdminPostProductsProductReq.md) | +| `payload` | [`AdminPostProductsProductReq`](internal-20.AdminPostProductsProductReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L39) +[medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L39) ___ ### updateOption -▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Parameters @@ -278,22 +278,22 @@ ___ | :------ | :------ | | `id` | `string` | | `optionId` | `string` | -| `payload` | [`AdminPostProductsProductOptionsOption`](internal-18.AdminPostProductsProductOptionsOption.md) | +| `payload` | [`AdminPostProductsProductOptionsOption`](internal-20.AdminPostProductsProductOptionsOption.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:133](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L133) +[medusa-js/src/resources/admin/products.ts:133](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L133) ___ ### updateVariant -▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Parameters @@ -301,13 +301,13 @@ ___ | :------ | :------ | | `id` | `string` | | `variantId` | `string` | -| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-18.AdminPostProductsProductVariantsVariantReq.md) | +| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-20.AdminPostProductsProductVariantsVariantReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-18.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:105](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/products.ts#L105) +[medusa-js/src/resources/admin/products.ts:105](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/products.ts#L105) diff --git a/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md b/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md new file mode 100644 index 0000000000..5071a08417 --- /dev/null +++ b/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md @@ -0,0 +1,135 @@ +# Class: AdminPublishableApiKeyResource + +## Hierarchy + +- `default` + + ↳ **`AdminPublishableApiKeyResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostPublishableApiKeysReq`](internal-21.AdminPostPublishableApiKeysReq.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> + +#### Defined in + +[medusa-js/src/resources/admin/publishable-api-keys.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L45) + +___ + +### 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/publishable-api-keys.ts:62](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L62) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-21.md#adminpublishableapikeyslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`GetPublishableApiKeysParams`](internal-21.GetPublishableApiKeysParams.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-21.md#adminpublishableapikeyslistres)\> + +#### Defined in + +[medusa-js/src/resources/admin/publishable-api-keys.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L31) + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `query?` | `Object` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> + +#### Defined in + +[medusa-js/src/resources/admin/publishable-api-keys.ts:16](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L16) + +___ + +### revoke + +▸ **revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> + +#### Defined in + +[medusa-js/src/resources/admin/publishable-api-keys.ts:70](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L70) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostPublishableApiKeysPublishableApiKeyReq`](internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[medusa-js/src/resources/admin/publishable-api-keys.ts:53](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L53) diff --git a/docs/content/references/js-client/classes/AdminRegionsResource.md b/docs/content/references/js-client/classes/AdminRegionsResource.md index ff68963ff3..986c5c132d 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-19.AdminRegionsRes.md)\> +▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.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-19.AdminPostRegionsRegionCountriesReq.md) | country data | +| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-22.AdminPostRegionsRegionCountriesReq.md) | country data | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L103) +[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L103) ___ ### addFulfillmentProvider -▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> **`Description`** @@ -49,24 +49,24 @@ adds a fulfillment provider to a region | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data | +| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L135) +[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L135) ___ ### addPaymentProvider -▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> **`Description`** @@ -77,24 +77,24 @@ adds a payment provider to a region | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-19.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data | +| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-22.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L181) +[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L181) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> **`Description`** @@ -104,18 +104,18 @@ creates a region. | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostRegionsReq`](internal-19.AdminPostRegionsReq.md) | +| `payload` | [`AdminPostRegionsReq`](internal-22.AdminPostRegionsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> created region. #### Defined in -[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L24) +[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L54) +[medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L54) ___ ### deleteCountry -▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.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-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L119) +[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L119) ___ ### deleteFulfillmentProvider -▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> **`Description`** @@ -192,19 +192,19 @@ remove a fulfillment provider from a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L151) +[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L151) ___ ### deletePaymentProvider -▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> **`Description`** @@ -220,19 +220,19 @@ removes a payment provider from a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> updated region #### Defined in -[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L197) +[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L197) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-19.md#adminregionslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.md#adminregionslistres)\> **`Description`** @@ -242,24 +242,24 @@ lists regions matching a query | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetRegionsParams`](internal-19.AdminGetRegionsParams.md) | query for searching regions | +| `query?` | [`AdminGetRegionsParams`](internal-22.AdminGetRegionsParams.md) | query for searching regions | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-19.md#adminregionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.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/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L82) +[medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L82) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> **`Description`** @@ -274,19 +274,19 @@ get a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> the region with the given id #### Defined in -[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L68) +[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L68) ___ ### retrieveFulfillmentOptions -▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> +▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.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-19.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> list of fulfillment options #### Defined in -[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L166) +[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L166) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> **`Description`** @@ -324,15 +324,15 @@ updates a region | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the region to update. | -| `payload` | [`AdminPostRegionsRegionReq`](internal-19.AdminPostRegionsRegionReq.md) | update to apply to region. | +| `payload` | [`AdminPostRegionsRegionReq`](internal-22.AdminPostRegionsRegionReq.md) | update to apply to region. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> the updated region. #### Defined in -[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L39) +[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/105c68929/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 6db8aaed63..e622d9851f 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-20.md#adminreturnreasonsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> **`Description`** @@ -20,18 +20,18 @@ Creates a return reason. | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostReturnReasonsReq`](internal-20.AdminPostReturnReasonsReq.md) | +| `payload` | [`AdminPostReturnReasonsReq`](internal-23.AdminPostReturnReasonsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> Created return reason. #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/return-reasons.ts#L48) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-20.md#adminreturnreasonslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-23.md#adminreturnreasonslistres)\> **`Description`** @@ -78,19 +78,19 @@ Lists return reasons matching a query #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-20.md#adminreturnreasonslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-23.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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/return-reasons.ts#L75) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> **`Description`** @@ -105,19 +105,19 @@ retrieves a return reason #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/return-reasons.ts#L62) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.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-20.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | +| `payload` | [`AdminPostReturnReasonsReasonReq`](internal-23.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-20.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> the updated return reason. #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 d8b0cca90a..1bdb629d65 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-21.md#adminreturnscancelres)\> +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-24.md#adminreturnscancelres)\> **`Description`** @@ -25,19 +25,19 @@ cancels a return #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-21.md#adminreturnscancelres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-24.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/a4dd26e13/packages/medusa-js/src/resources/admin/returns.ts#L19) +[medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/returns.ts#L19) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-21.md#adminreturnslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-24.md#adminreturnslistres)\> **`Description`** @@ -47,24 +47,24 @@ lists returns matching a query | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetReturnsParams`](internal-21.AdminGetReturnsParams.md) | query for searching returns | +| `query?` | [`AdminGetReturnsParams`](internal-24.AdminGetReturnsParams.md) | query for searching returns | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-21.md#adminreturnslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-24.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/a4dd26e13/packages/medusa-js/src/resources/admin/returns.ts#L49) +[medusa-js/src/resources/admin/returns.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/returns.ts#L49) ___ ### receive -▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-21.md#adminreturnsres)\> +▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-24.md#adminreturnsres)\> **`Description`** @@ -75,15 +75,15 @@ receive a return | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the return to receive. | -| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-21.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | +| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-24.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-21.md#adminreturnsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-24.md#adminreturnsres)\> the return #### Defined in -[medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/returns.ts#L34) +[medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/105c68929/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 7f3756e166..b52942742d 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-22.md#adminsaleschannelsres)\> +▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.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-22.AdminPostSalesChannelsChannelProductsBatchReq.md) | +| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> a medusa sales channel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:116](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/sales-channels.ts#L116) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostSalesChannelsReq`](internal-22.AdminPostSalesChannelsReq.md) | +| `payload` | [`AdminPostSalesChannelsReq`](internal-25.AdminPostSalesChannelsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:34](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/sales-channels.ts#L85) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-22.md#adminsaleschannelslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-25.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-22.AdminGetSalesChannelsParams.md) | +| `query?` | [`AdminGetSalesChannelsParams`](internal-25.AdminGetSalesChannelsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-22.md#adminsaleschannelslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-25.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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/sales-channels.ts#L64) ___ ### removeProducts -▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> +▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.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-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md) | +| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> a medusa sales channel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:100](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/sales-channels.ts#L100) ___ ### retrieve -▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> +▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.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-22.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> a medusa sales channel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:22](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/sales-channels.ts#L22) ___ ### update -▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> +▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.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-22.AdminPostSalesChannelsSalesChannelReq.md) | +| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-25.AdminPostSalesChannelsSalesChannelReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-22.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> the updated medusa sales channel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:48](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 72a0557dd4..bd8b156da9 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-23.md#adminshippingoptionsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> **`Description`** @@ -20,18 +20,18 @@ creates a shipping option. | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostShippingOptionsReq`](internal-23.AdminPostShippingOptionsReq.md) | +| `payload` | [`AdminPostShippingOptionsReq`](internal-26.AdminPostShippingOptionsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> created shipping option. #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/shipping-options.ts#L50) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-23.md#adminshippingoptionslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-26.md#adminshippingoptionslistres)\> **`Description`** @@ -74,24 +74,24 @@ lists shipping options matching a query | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetShippingOptionsParams`](internal-23.AdminGetShippingOptionsParams.md) | query for searching shipping options | +| `query?` | [`AdminGetShippingOptionsParams`](internal-26.AdminGetShippingOptionsParams.md) | query for searching shipping options | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-23.md#adminshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-26.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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/shipping-options.ts#L78) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> **`Description`** @@ -106,19 +106,19 @@ get a shipping option #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/shipping-options.ts#L64) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.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-23.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | +| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-26.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-23.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> the updated shipping option. #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 50ed1e3c89..c8594bdc8d 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-24.md#adminshippingprofilesres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostShippingProfilesReq`](internal-24.AdminPostShippingProfilesReq.md) | +| `payload` | [`AdminPostShippingProfilesReq`](internal-27.AdminPostShippingProfilesReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-24.md#adminshippingprofileslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-27.md#adminshippingprofileslistres)\> #### Parameters @@ -62,17 +62,17 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-24.md#adminshippingprofileslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-27.md#adminshippingprofileslistres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> #### Parameters @@ -83,30 +83,30 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-24.AdminPostShippingProfilesProfileReq.md) | +| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-27.AdminPostShippingProfilesProfileReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-24.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 8d6c101f99..6a18b4d5cb 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-25.md#adminstoresres)\> +▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> **`Description`** @@ -25,19 +25,19 @@ adds a currency to the store. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> updated store. #### Defined in -[medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/store.ts#L31) +[medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/store.ts#L31) ___ ### deleteCurrency -▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> +▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> **`Description`** @@ -52,19 +52,19 @@ deletes a currency from the available store currencies #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> updated store #### Defined in -[medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/store.ts#L45) +[medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/store.ts#L45) ___ ### listPaymentProviders -▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-25.md#adminpaymentproviderslist)\> +▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-28.md#adminpaymentproviderslist)\> **`Description`** @@ -78,19 +78,19 @@ Lists the store's payment providers #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-25.md#adminpaymentproviderslist)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-28.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/a4dd26e13/packages/medusa-js/src/resources/admin/store.ts#L68) +[medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/store.ts#L68) ___ ### listTaxProviders -▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-25.md#admintaxproviderslist)\> +▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-28.md#admintaxproviderslist)\> **`Description`** @@ -104,19 +104,19 @@ Lists the store's payment providers #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-25.md#admintaxproviderslist)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-28.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/a4dd26e13/packages/medusa-js/src/resources/admin/store.ts#L79) +[medusa-js/src/resources/admin/store.ts:79](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/store.ts#L79) ___ ### retrieve -▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> +▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> **`Description`** @@ -130,19 +130,19 @@ gets a medusa store #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> a medusa store #### Defined in -[medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/store.ts#L57) +[medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/store.ts#L57) ___ ### update -▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> +▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> **`Description`** @@ -152,15 +152,15 @@ Updates the store | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminPostStoreReq`](internal-25.AdminPostStoreReq.md) | update to apply to the store. | +| `payload` | [`AdminPostStoreReq`](internal-28.AdminPostStoreReq.md) | update to apply to the store. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-25.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> the updated store. #### Defined in -[medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/store.ts#L17) +[medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/105c68929/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 690e0a986c..183cb32468 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-26.md#adminswapslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-29.md#adminswapslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetSwapsParams`](internal-26.AdminGetSwapsParams.md) | +| `query?` | [`AdminGetSwapsParams`](internal-29.AdminGetSwapsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-26.md#adminswapslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-29.md#adminswapslistres)\> #### Defined in -[medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/swaps.ts#L19) +[medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/swaps.ts#L19) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-26.md#adminswapsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-29.md#adminswapsres)\> #### Parameters @@ -42,8 +42,8 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-26.md#adminswapsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-29.md#adminswapsres)\> #### Defined in -[medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/swaps.ts#L11) +[medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/105c68929/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 63e49784ba..b464c837df 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-27.md#admintaxratesres)\> +▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L100) ___ ### addProducts -▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-27.AdminPostTaxRatesTaxRateProductsReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-30.AdminPostTaxRatesTaxRateProductsReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L84) ___ ### addShippingOptions -▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L116) ___ ### create -▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostTaxRatesReq`](internal-27.AdminPostTaxRatesReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesReq`](internal-30.AdminPostTaxRatesReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L180) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-27.md#admintaxrateslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-30.md#admintaxrateslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetTaxRatesParams`](internal-27.AdminGetTaxRatesParams.md) | +| `query?` | [`AdminGetTaxRatesParams`](internal-30.AdminGetTaxRatesParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-27.md#admintaxrateslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-30.md#admintaxrateslistres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L39) ___ ### removeProductTypes -▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | +| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L148) ___ ### removeProducts -▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md) | +| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L132) ___ ### removeShippingOptions -▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | +| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L164) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/packages/medusa-js/src/resources/admin/tax-rates.ts#L24) ___ ### update -▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-27.AdminPostTaxRatesTaxRateReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | +| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-30.AdminPostTaxRatesTaxRateReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-27.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/a4dd26e13/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/105c68929/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 429ad50886..8e8656b670 100644 --- a/docs/content/references/js-client/classes/AdminUploadsResource.md +++ b/docs/content/references/js-client/classes/AdminUploadsResource.md @@ -20,47 +20,47 @@ #### Defined in -[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/uploads.ts#L14) +[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/uploads.ts#L14) ## Methods ### create -▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-28.md#adminuploadsres)\> +▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `file` | [`IAdminPostUploadsFileReq`](internal-28.IAdminPostUploadsFileReq.md) | +| `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-28.md#adminuploadsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> #### Defined in -[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/uploads.ts#L18) +[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/uploads.ts#L18) ___ ### createProtected -▸ **createProtected**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-28.md#adminuploadsres)\> +▸ **createProtected**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `file` | [`IAdminPostUploadsFileReq`](internal-28.IAdminPostUploadsFileReq.md) | +| `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-28.md#adminuploadsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> #### Defined in -[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/uploads.ts#L27) +[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/uploads.ts#L27) ___ @@ -72,7 +72,7 @@ ___ | Name | Type | | :------ | :------ | -| `payload` | [`AdminDeleteUploadsReq`](internal-28.AdminDeleteUploadsReq.md) | +| `payload` | [`AdminDeleteUploadsReq`](internal-31.AdminDeleteUploadsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns @@ -81,25 +81,25 @@ ___ #### Defined in -[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/uploads.ts#L36) +[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/uploads.ts#L36) ___ ### getPresignedDownloadUrl -▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-28.md#adminuploadsdownloadurlres)\> +▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-31.md#adminuploadsdownloadurlres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-28.AdminPostUploadsDownloadUrlReq.md) | +| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-31.AdminPostUploadsDownloadUrlReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-28.md#adminuploadsdownloadurlres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-31.md#adminuploadsdownloadurlres)\> #### Defined in -[medusa-js/src/resources/admin/uploads.ts:45](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/uploads.ts#L45) +[medusa-js/src/resources/admin/uploads.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/uploads.ts#L45) diff --git a/docs/content/references/js-client/classes/AdminUsersResource.md b/docs/content/references/js-client/classes/AdminUsersResource.md index b3f1f83d9a..61999332d0 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-29.md#adminuserres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> **`Description`** @@ -20,18 +20,18 @@ creates a user with the provided information | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminCreateUserPayload`](../modules/internal-29.md#admincreateuserpayload) | user creation request body | +| `payload` | [`AdminCreateUserPayload`](../modules/internal-32.md#admincreateuserpayload) | user creation request body | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> created user #### Defined in -[medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/users.ts#L64) +[medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/admin/users.ts#L94) +[medusa-js/src/resources/admin/users.ts:94](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/users.ts#L94) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-29.md#adminuserslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-32.md#adminuserslistres)\> **`Description`** @@ -78,19 +78,19 @@ lists all users #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-29.md#adminuserslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-32.md#adminuserslistres)\> a list of all users #### Defined in -[medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/users.ts#L106) +[medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/users.ts#L106) ___ ### resetPassword -▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> +▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> **`Description`** @@ -100,22 +100,22 @@ resets the users password given the correct token. | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminResetPasswordRequest`](internal-29.AdminResetPasswordRequest.md) | reset password information. | +| `payload` | [`AdminResetPasswordRequest`](internal-32.AdminResetPasswordRequest.md) | reset password information. | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> #### Defined in -[medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/users.ts#L36) +[medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/users.ts#L36) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> Retrieves a given user @@ -128,13 +128,13 @@ Retrieves a given user #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> the user #### Defined in -[medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/users.ts#L50) +[medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/105c68929/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-29.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. | +| `payload` | [`AdminResetPasswordTokenRequest`](internal-32.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/a4dd26e13/packages/medusa-js/src/resources/admin/users.ts#L22) +[medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/users.ts#L22) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.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-29.md#adminupdateuserpayload) | user update request body | +| `payload` | [`AdminUpdateUserPayload`](../modules/internal-32.md#adminupdateuserpayload) | user update request body | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-29.md#adminuserres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> the updated user #### Defined in -[medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/users.ts#L79) +[medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/105c68929/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 57801467a0..ec16020068 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-30.md#adminvariantslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-33.md#adminvariantslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetVariantsParams`](internal-30.AdminGetVariantsParams.md) | +| `query?` | [`AdminGetVariantsParams`](internal-33.AdminGetVariantsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-30.md#adminvariantslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-33.md#adminvariantslistres)\> #### Defined in -[medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/variants.ts#L7) +[medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/105c68929/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 7a11128235..2b12bed120 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-31.md#storeauthres)\> +▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> **`Description`** @@ -20,16 +20,16 @@ Authenticates a customer using email and password combination | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostAuthReq`](internal-31.StorePostAuthReq.md) | authentication payload | +| `payload` | [`StorePostAuthReq`](internal-34.StorePostAuthReq.md) | authentication payload | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-31.md#storeauthres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> #### Defined in -[medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/auth.ts#L16) +[medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/resources/auth.ts#L25) +[medusa-js/src/resources/auth.ts:25](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/auth.ts#L25) ___ ### exists -▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-31.md#storegetauthemailres)\> +▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-34.md#storegetauthemailres)\> **`Description`** @@ -74,17 +74,17 @@ Check if email exists #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-31.md#storegetauthemailres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-34.md#storegetauthemailres)\> #### Defined in -[medusa-js/src/resources/auth.ts:47](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/auth.ts#L47) +[medusa-js/src/resources/auth.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/auth.ts#L47) ___ ### getSession -▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-31.md#storeauthres)\> +▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.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-31.md#storeauthres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> #### Defined in -[medusa-js/src/resources/auth.ts:36](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/auth.ts#L36) +[medusa-js/src/resources/auth.ts:36](https://github.com/medusajs/medusa/blob/105c68929/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 935912f11d..482e0357dc 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/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L15) +[medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L15) ## Methods ### addShippingMethod -▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-32.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data | +| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-35.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L24) +[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L24) ___ ### complete -▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-32.md#storecompletecartres)\> +▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-35.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-32.md#storecompletecartres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-35.md#storecompletecartres)\> #### Defined in -[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L43) +[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L43) ___ ### create -▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> Creates a cart @@ -79,22 +79,22 @@ Creates a cart | Name | Type | Description | | :------ | :------ | :------ | -| `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 | +| `payload?` | [`StorePostCartReq`](internal-35.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-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L58) +[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L58) ___ ### createPaymentSessions -▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L74) +[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L74) ___ ### deleteDiscount -▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L89) +[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L89) ___ ### deletePaymentSession -▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L106) +[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L106) ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> Refreshes a payment session. @@ -182,17 +182,17 @@ Refreshes a payment session. #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L122) +[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L122) ___ ### retrieve -▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> Retrieves a cart @@ -205,17 +205,17 @@ Retrieves a cart #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L137) +[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L137) ___ ### setPaymentSession -▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-32.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" | +| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-35.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L152) +[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L152) ___ ### update -▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> Updates a cart @@ -248,22 +248,22 @@ Updates a cart | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `payload` | [`StorePostCartsCartReq`](internal-32.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address | +| `payload` | [`StorePostCartsCartReq`](internal-35.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-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L168) +[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/carts.ts#L168) ___ ### updatePaymentSession -▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-32.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | +| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-35.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/carts.ts#L185) +[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/105c68929/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 8b2373a9fb..40cd7ed71e 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-33.md#storecollectionslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-36.md#storecollectionslistres)\> **`Description`** @@ -20,22 +20,22 @@ Retrieves a list of collections | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`StoreGetCollectionsParams`](internal-33.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `query?` | [`StoreGetCollectionsParams`](internal-36.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-33.md#storecollectionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-36.md#storecollectionslistres)\> #### Defined in -[medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/collections.ts#L28) +[medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/collections.ts#L28) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-33.md#storecollectionsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-36.md#storecollectionsres)\> **`Description`** @@ -50,8 +50,8 @@ Retrieves a single collection #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-33.md#storecollectionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-36.md#storecollectionsres)\> #### Defined in -[medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/collections.ts#L17) +[medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/105c68929/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 7ad2efecbe..988fa3c90e 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:18](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/customers.ts#L18) +[medusa-js/src/resources/customers.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/customers.ts#L18) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/customers.ts#L17) +[medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/customers.ts#L17) ## Methods @@ -38,7 +38,7 @@ Creates a customer | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersReq`](internal-34.StorePostCustomersReq.md) | information of customer | +| `payload` | [`StorePostCustomersReq`](internal-37.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:26](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/customers.ts#L26) +[medusa-js/src/resources/customers.ts:26](https://github.com/medusajs/medusa/blob/105c68929/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-34.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token | +| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-37.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:101](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/customers.ts#L101) +[medusa-js/src/resources/customers.ts:101](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/customers.ts#L101) ___ ### listOrders -▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-34.md#storecustomerslistordersres)\> +▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-37.md#storecustomerslistordersres)\> Retrieve customer orders @@ -85,16 +85,16 @@ Retrieve customer orders | Name | Type | Description | | :------ | :------ | :------ | -| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-34.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | +| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-37.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-34.md#storecustomerslistordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-37.md#storecustomerslistordersres)\> #### Defined in -[medusa-js/src/resources/customers.ts:66](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/customers.ts#L66) +[medusa-js/src/resources/customers.ts:66](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/customers.ts#L66) ___ @@ -108,7 +108,7 @@ Resets customer password | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersResetPasswordReq`](internal-34.StorePostCustomersResetPasswordReq.md) | info used to reset customer password | +| `payload` | [`StorePostCustomersResetPasswordReq`](internal-37.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:86](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/customers.ts#L86) +[medusa-js/src/resources/customers.ts:86](https://github.com/medusajs/medusa/blob/105c68929/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:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/customers.ts#L39) +[medusa-js/src/resources/customers.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/customers.ts#L39) ___ @@ -153,7 +153,7 @@ Updates a customer | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerReq`](internal-34.StorePostCustomersCustomerReq.md) | information to update customer with | +| `payload` | [`StorePostCustomersCustomerReq`](internal-37.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:52](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/customers.ts#L52) +[medusa-js/src/resources/customers.ts:52](https://github.com/medusajs/medusa/blob/105c68929/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 5e5900aaf6..9b6142b24d 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-35.md#storegiftcardsres)\> +▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-38.md#storegiftcardsres)\> **`Description`** @@ -25,8 +25,8 @@ Retrieves a single GiftCard #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-35.md#storegiftcardsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-38.md#storegiftcardsres)\> #### Defined in -[medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/gift-cards.ts#L12) +[medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/105c68929/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 c30488afe4..d974ebf8ab 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-32.md#storecartsres)\> +▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-36.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item | +| `payload` | [`StorePostCartsCartLineItemsReq`](internal-39.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/line-items.ts#L17) +[medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/line-items.ts#L17) ___ ### delete -▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/line-items.ts#L50) +[medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/105c68929/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-32.md#storecartsres)\> +▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.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-36.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item | +| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-39.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-32.md#storecartsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/line-items.ts#L34) +[medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/105c68929/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 index 97db08cacc..cc39f1ddff 100644 --- a/docs/content/references/js-client/classes/OrderEditsResource.md +++ b/docs/content/references/js-client/classes/OrderEditsResource.md @@ -25,7 +25,7 @@ #### Defined in -[medusa-js/src/resources/order-edits.ts:26](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/order-edits.ts#L26) +[medusa-js/src/resources/order-edits.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/order-edits.ts#L26) ___ @@ -38,7 +38,7 @@ ___ | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-37.StorePostOrderEditsOrderEditDecline.md) | +| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-40.StorePostOrderEditsOrderEditDecline.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns @@ -47,13 +47,13 @@ ___ #### Defined in -[medusa-js/src/resources/order-edits.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/order-edits.ts#L17) +[medusa-js/src/resources/order-edits.ts:17](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/order-edits.ts#L17) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-37.md#storeordereditsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-40.md#storeordereditsres)\> #### Parameters @@ -64,8 +64,8 @@ ___ #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-37.md#storeordereditsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-40.md#storeordereditsres)\> #### Defined in -[medusa-js/src/resources/order-edits.ts:9](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/order-edits.ts#L9) +[medusa-js/src/resources/order-edits.ts:9](https://github.com/medusajs/medusa/blob/105c68929/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 6c2832f8b1..f37ce04214 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-38.md#storeordersres)\> +▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> **`Description`** @@ -20,22 +20,22 @@ Look up an order using order details | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StoreGetOrdersParams`](internal-38.StoreGetOrdersParams.md) | details used to look up the order | +| `payload` | [`StoreGetOrdersParams`](internal-41.StoreGetOrdersParams.md) | details used to look up the order | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> #### Defined in -[medusa-js/src/resources/orders.ts:41](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/orders.ts#L41) +[medusa-js/src/resources/orders.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/orders.ts#L41) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> **`Description`** @@ -50,17 +50,17 @@ Retrieves an order #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> #### Defined in -[medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/orders.ts#L13) +[medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/orders.ts#L13) ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> **`Description`** @@ -75,8 +75,8 @@ Retrieves an order by cart id #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-38.md#storeordersres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> #### Defined in -[medusa-js/src/resources/orders.ts:27](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/orders.ts#L27) +[medusa-js/src/resources/orders.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/orders.ts#L27) diff --git a/docs/content/references/js-client/classes/PaymentCollectionsResource.md b/docs/content/references/js-client/classes/PaymentCollectionsResource.md new file mode 100644 index 0000000000..8eb371ce5c --- /dev/null +++ b/docs/content/references/js-client/classes/PaymentCollectionsResource.md @@ -0,0 +1,95 @@ +# Class: PaymentCollectionsResource + +## Hierarchy + +- `default` + + ↳ **`PaymentCollectionsResource`** + +## Methods + +### authorize + +▸ **authorize**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionRes`](../modules/internal-42.md#storepaymentcollectionres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionRes`](../modules/internal-42.md#storepaymentcollectionres)\> + +#### Defined in + +[medusa-js/src/resources/payment-collections.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/payment-collections.ts#L28) + +___ + +### manageSessions + +▸ **manageSessions**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionRes`](../modules/internal-42.md#storepaymentcollectionres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`StoreManagePaymentCollectionSessionRequest`](internal-42.StoreManagePaymentCollectionSessionRequest.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionRes`](../modules/internal-42.md#storepaymentcollectionres)\> + +#### Defined in + +[medusa-js/src/resources/payment-collections.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/payment-collections.ts#L36) + +___ + +### refreshPaymentSession + +▸ **refreshPaymentSession**(`id`, `session_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionSessionRes`](../modules/internal-42.md#storepaymentcollectionsessionres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `session_id` | `string` | +| `payload` | [`StoreRefreshPaymentCollectionSessionRequest`](internal-42.StoreRefreshPaymentCollectionSessionRequest.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionSessionRes`](../modules/internal-42.md#storepaymentcollectionsessionres)\> + +#### Defined in + +[medusa-js/src/resources/payment-collections.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/payment-collections.ts#L45) + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionRes`](../modules/internal-42.md#storepaymentcollectionres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `query?` | [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) | +| `customHeaders` | `Record`<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionRes`](../modules/internal-42.md#storepaymentcollectionres)\> + +#### Defined in + +[medusa-js/src/resources/payment-collections.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/payment-collections.ts#L13) diff --git a/docs/content/references/js-client/classes/PaymentMethodsResource.md b/docs/content/references/js-client/classes/PaymentMethodsResource.md index 25edff9648..639c01c6f4 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-39.md#storecustomerslistpaymentmethodsres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-43.md#storecustomerslistpaymentmethodsres)\> Lists customer payment methods @@ -22,8 +22,8 @@ Lists customer payment methods #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-39.md#storecustomerslistpaymentmethodsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-43.md#storecustomerslistpaymentmethodsres)\> #### Defined in -[medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/payment-methods.ts#L12) +[medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/payment-methods.ts#L12) diff --git a/docs/content/references/js-client/classes/ProductTypesResource.md b/docs/content/references/js-client/classes/ProductTypesResource.md index d3c7491be6..31e1491137 100644 --- a/docs/content/references/js-client/classes/ProductTypesResource.md +++ b/docs/content/references/js-client/classes/ProductTypesResource.md @@ -10,7 +10,7 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-40.md#storeproducttypeslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-44.md#storeproducttypeslistres)\> **`Description`** @@ -20,13 +20,13 @@ Retrieves a list of product types | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`StoreGetProductTypesParams`](internal-40.StoreGetProductTypesParams.md) | is optional. Can contain a limit and offset for the returned list | +| `query?` | [`StoreGetProductTypesParams`](internal-44.StoreGetProductTypesParams.md) | is optional. Can contain a limit and offset for the returned list | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-40.md#storeproducttypeslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-44.md#storeproducttypeslistres)\> #### Defined in -[medusa-js/src/resources/product-types.ts:16](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/product-types.ts#L16) +[medusa-js/src/resources/product-types.ts:16](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/product-types.ts#L16) diff --git a/docs/content/references/js-client/classes/ProductVariantsResource.md b/docs/content/references/js-client/classes/ProductVariantsResource.md index fcf5c0e4f2..b3183fcf4e 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-41.md#storevariantslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-45.md#storevariantslistres)\> **`Description`** @@ -20,22 +20,22 @@ Retrieves a list of of Product Variants | Name | Type | | :------ | :------ | -| `query?` | [`StoreGetVariantsParams`](internal-41.StoreGetVariantsParams.md) | +| `query?` | [`StoreGetVariantsParams`](internal-45.StoreGetVariantsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-41.md#storevariantslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-45.md#storevariantslistres)\> #### Defined in -[medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/product-variants.ts#L28) +[medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/product-variants.ts#L28) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-41.md#storevariantsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-45.md#storevariantsres)\> **`Description`** @@ -50,8 +50,8 @@ Retrieves a single product variant #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-41.md#storevariantsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-45.md#storevariantsres)\> #### Defined in -[medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/product-variants.ts#L17) +[medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/105c68929/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 cbd1356d8f..7fc882746e 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/a4dd26e13/packages/medusa-js/src/resources/products.ts#L14) +[medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/products.ts#L14) ## Methods ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-42.md#storeproductslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-46.md#storeproductslistres)\> **`Description`** @@ -30,22 +30,22 @@ Retrieves a list of products | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`StoreGetProductsParams`](internal-42.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `query?` | [`StoreGetProductsParams`](internal-46.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-42.md#storeproductslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-46.md#storeproductslistres)\> #### Defined in -[medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/products.ts#L50) +[medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/products.ts#L50) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-42.md#storeproductsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-46.md#storeproductsres)\> **`Description`** @@ -60,17 +60,17 @@ Retrieves a single Product #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-42.md#storeproductsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-46.md#storeproductsres)\> #### Defined in -[medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/products.ts#L22) +[medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/products.ts#L22) ___ ### search -▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-42.md#storepostsearchres)\> +▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-46.md#storepostsearchres)\> **`Description`** @@ -80,13 +80,13 @@ Searches for products | Name | Type | Description | | :------ | :------ | :------ | -| `searchOptions` | [`StorePostSearchReq`](internal-42.StorePostSearchReq.md) | is required | +| `searchOptions` | [`StorePostSearchReq`](internal-46.StorePostSearchReq.md) | is required | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-42.md#storepostsearchres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-46.md#storepostsearchres)\> #### Defined in -[medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/products.ts#L36) +[medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/105c68929/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 3970151c95..8ef08884c8 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-43.md#storeregionslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-47.md#storeregionslistres)\> **`Description`** @@ -24,17 +24,17 @@ Retrieves a list of regions #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-43.md#storeregionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-47.md#storeregionslistres)\> #### Defined in -[medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/regions.ts#L11) +[medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/regions.ts#L11) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-43.md#storeregionsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-47.md#storeregionsres)\> **`Description`** @@ -49,8 +49,8 @@ Retrieves a region #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-43.md#storeregionsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-47.md#storeregionsres)\> #### Defined in -[medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/regions.ts#L22) +[medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/105c68929/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 4c78d0f3f0..fc83489c96 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-44.md#storereturnreasonslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-48.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-44.md#storereturnreasonslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-48.md#storereturnreasonslistres)\> #### Defined in -[medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/return-reasons.ts#L25) +[medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/return-reasons.ts#L25) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-44.md#storereturnreasonsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-48.md#storereturnreasonsres)\> **`Description`** @@ -47,8 +47,8 @@ Retrieves a single Return Reason #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-44.md#storereturnreasonsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-48.md#storereturnreasonsres)\> #### Defined in -[medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/return-reasons.ts#L15) +[medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/105c68929/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 c2a277e349..7763cb5a85 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-45.md#storereturnsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-49.md#storereturnsres)\> Creates a return request @@ -18,13 +18,13 @@ Creates a return request | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostReturnsReq`](internal-45.StorePostReturnsReq.md) | details needed to create a return | +| `payload` | [`StorePostReturnsReq`](internal-49.StorePostReturnsReq.md) | details needed to create a return | | `customHeaders` | `Record`<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-45.md#storereturnsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-49.md#storereturnsres)\> #### Defined in -[medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/returns.ts#L12) +[medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/105c68929/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 370d606d11..7eaa682d64 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-46.md#storeshippingoptionslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> **`Description`** @@ -20,22 +20,22 @@ Lists shiping options available | Name | Type | | :------ | :------ | -| `query?` | [`StoreGetShippingOptionsParams`](internal-46.StoreGetShippingOptionsParams.md) | +| `query?` | [`StoreGetShippingOptionsParams`](internal-50.StoreGetShippingOptionsParams.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-46.md#storeshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> #### Defined in -[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/shipping-options.ts#L27) +[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/shipping-options.ts#L27) ___ ### listCartOptions -▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-46.md#storeshippingoptionslistres)\> +▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> **`Description`** @@ -50,8 +50,8 @@ Lists shiping options available for a cart #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-46.md#storeshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> #### Defined in -[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/shipping-options.ts#L16) +[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/105c68929/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 29b0c5f347..c37ffe8f5f 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-47.md#storeswapsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> **`Description`** @@ -20,22 +20,22 @@ Creates a swap from a cart | Name | Type | | :------ | :------ | -| `payload` | [`StorePostSwapsReq`](internal-47.StorePostSwapsReq.md) | +| `payload` | [`StorePostSwapsReq`](internal-51.StorePostSwapsReq.md) | | `customHeaders` | `Record`<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-47.md#storeswapsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> #### Defined in -[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/swaps.ts#L12) +[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/swaps.ts#L12) ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-47.md#storeswapsres)\> +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> **`Description`** @@ -50,8 +50,8 @@ Retrieves a swap by cart id #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-47.md#storeswapsres)\> +[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> #### Defined in -[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/swaps.ts#L23) +[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/swaps.ts#L23) diff --git a/docs/content/references/js-client/classes/internal-15.AdminUpdatePaymentCollectionRequest.md b/docs/content/references/js-client/classes/internal-15.AdminUpdatePaymentCollectionRequest.md new file mode 100644 index 0000000000..1f3f5ba7cf --- /dev/null +++ b/docs/content/references/js-client/classes/internal-15.AdminUpdatePaymentCollectionRequest.md @@ -0,0 +1,23 @@ +# Class: AdminUpdatePaymentCollectionRequest + +[internal](../modules/internal-15.md).AdminUpdatePaymentCollectionRequest + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/payment-collections/update-payment-collection.d.ts:72 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/payment-collections/update-payment-collection.d.ts:73 diff --git a/docs/content/references/js-client/classes/internal-15.GetPaymentCollectionsParams.md b/docs/content/references/js-client/classes/internal-15.GetPaymentCollectionsParams.md new file mode 100644 index 0000000000..49fd8f0ccf --- /dev/null +++ b/docs/content/references/js-client/classes/internal-15.GetPaymentCollectionsParams.md @@ -0,0 +1,37 @@ +# Class: GetPaymentCollectionsParams + +[internal](../modules/internal-15.md).GetPaymentCollectionsParams + +## Hierarchy + +- [`FindParams`](internal-5.FindParams.md) + + ↳ **`GetPaymentCollectionsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) + +#### Defined in + +medusa/dist/types/common.d.ts:117 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) + +#### Defined in + +medusa/dist/types/common.d.ts:118 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostPaymentRefundsReq.md b/docs/content/references/js-client/classes/internal-16.AdminPostPaymentRefundsReq.md new file mode 100644 index 0000000000..ff1ce19a41 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminPostPaymentRefundsReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostPaymentRefundsReq + +[internal](../modules/internal-16.md).AdminPostPaymentRefundsReq + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/payments/refund-payment.d.ts:83 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/payments/refund-payment.d.ts:85 + +___ + +### reason + +• **reason**: [`RefundReason`](../enums/internal-16.RefundReason.md) + +#### Defined in + +medusa/dist/api/routes/admin/payments/refund-payment.d.ts:84 diff --git a/docs/content/references/js-client/classes/internal-16.GetPaymentsParams.md b/docs/content/references/js-client/classes/internal-16.GetPaymentsParams.md new file mode 100644 index 0000000000..bce8dcf7c1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.GetPaymentsParams.md @@ -0,0 +1,37 @@ +# Class: GetPaymentsParams + +[internal](../modules/internal-16.md).GetPaymentsParams + +## Hierarchy + +- [`FindParams`](internal-5.FindParams.md) + + ↳ **`GetPaymentsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) + +#### Defined in + +medusa/dist/types/common.d.ts:117 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) + +#### Defined in + +medusa/dist/types/common.d.ts:118 diff --git a/docs/content/references/js-client/classes/internal-15.AdminDeletePriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal-17.AdminDeletePriceListPricesPricesReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-15.AdminDeletePriceListPricesPricesReq.md rename to docs/content/references/js-client/classes/internal-17.AdminDeletePriceListPricesPricesReq.md index 88bbf62f0e..5a50700f0e 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminDeletePriceListPricesPricesReq.md +++ b/docs/content/references/js-client/classes/internal-17.AdminDeletePriceListPricesPricesReq.md @@ -1,6 +1,6 @@ # Class: AdminDeletePriceListPricesPricesReq -[internal](../modules/internal-15.md).AdminDeletePriceListPricesPricesReq +[internal](../modules/internal-17.md).AdminDeletePriceListPricesPricesReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-15.AdminGetPriceListPaginationParams.md b/docs/content/references/js-client/classes/internal-17.AdminGetPriceListPaginationParams.md similarity index 63% rename from docs/content/references/js-client/classes/internal-15.AdminGetPriceListPaginationParams.md rename to docs/content/references/js-client/classes/internal-17.AdminGetPriceListPaginationParams.md index 9f7ce2151a..f307a8b445 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminGetPriceListPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-17.AdminGetPriceListPaginationParams.md @@ -1,10 +1,10 @@ # Class: AdminGetPriceListPaginationParams -[internal](../modules/internal-15.md).AdminGetPriceListPaginationParams +[internal](../modules/internal-17.md).AdminGetPriceListPaginationParams ## Hierarchy -- [`FilterablePriceListProps`](internal-15.FilterablePriceListProps.md) +- [`FilterablePriceListProps`](internal-17.FilterablePriceListProps.md) ↳ **`AdminGetPriceListPaginationParams`** @@ -16,7 +16,7 @@ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[created_at](internal-15.FilterablePriceListProps.md#created_at) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[created_at](internal-17.FilterablePriceListProps.md#created_at) #### Defined in @@ -30,7 +30,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[customer_groups](internal-15.FilterablePriceListProps.md#customer_groups) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[customer_groups](internal-17.FilterablePriceListProps.md#customer_groups) #### Defined in @@ -44,7 +44,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[deleted_at](internal-15.FilterablePriceListProps.md#deleted_at) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[deleted_at](internal-17.FilterablePriceListProps.md#deleted_at) #### Defined in @@ -58,7 +58,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[description](internal-15.FilterablePriceListProps.md#description) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[description](internal-17.FilterablePriceListProps.md#description) #### Defined in @@ -82,7 +82,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[id](internal-15.FilterablePriceListProps.md#id) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[id](internal-17.FilterablePriceListProps.md#id) #### Defined in @@ -106,7 +106,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[name](internal-15.FilterablePriceListProps.md#name) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[name](internal-17.FilterablePriceListProps.md#name) #### Defined in @@ -140,7 +140,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[q](internal-15.FilterablePriceListProps.md#q) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[q](internal-17.FilterablePriceListProps.md#q) #### Defined in @@ -154,7 +154,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[status](internal-15.FilterablePriceListProps.md#status) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[status](internal-17.FilterablePriceListProps.md#status) #### Defined in @@ -168,7 +168,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[type](internal-15.FilterablePriceListProps.md#type) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[type](internal-17.FilterablePriceListProps.md#type) #### Defined in @@ -182,7 +182,7 @@ ___ #### Inherited from -[FilterablePriceListProps](internal-15.FilterablePriceListProps.md).[updated_at](internal-15.FilterablePriceListProps.md#updated_at) +[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[updated_at](internal-17.FilterablePriceListProps.md#updated_at) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-15.AdminGetPriceListsPriceListProductsParams.md b/docs/content/references/js-client/classes/internal-17.AdminGetPriceListsPriceListProductsParams.md similarity index 96% rename from docs/content/references/js-client/classes/internal-15.AdminGetPriceListsPriceListProductsParams.md rename to docs/content/references/js-client/classes/internal-17.AdminGetPriceListsPriceListProductsParams.md index c2956a0361..c0d7660cbd 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminGetPriceListsPriceListProductsParams.md +++ b/docs/content/references/js-client/classes/internal-17.AdminGetPriceListsPriceListProductsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetPriceListsPriceListProductsParams -[internal](../modules/internal-15.md).AdminGetPriceListsPriceListProductsParams +[internal](../modules/internal-17.md).AdminGetPriceListsPriceListProductsParams ## Hierarchy -- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-15.md#admingetpricelistspricelistproductsparams_base) +- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-17.md#admingetpricelistspricelistproductsparams_base) ↳ **`AdminGetPriceListsPriceListProductsParams`** diff --git a/docs/content/references/js-client/classes/internal-15.AdminPostPriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostPriceListPricesPricesReq.md similarity index 72% rename from docs/content/references/js-client/classes/internal-15.AdminPostPriceListPricesPricesReq.md rename to docs/content/references/js-client/classes/internal-17.AdminPostPriceListPricesPricesReq.md index 2f3c1d6087..b384afd104 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminPostPriceListPricesPricesReq.md +++ b/docs/content/references/js-client/classes/internal-17.AdminPostPriceListPricesPricesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostPriceListPricesPricesReq -[internal](../modules/internal-15.md).AdminPostPriceListPricesPricesReq +[internal](../modules/internal-17.md).AdminPostPriceListPricesPricesReq ## Properties @@ -16,7 +16,7 @@ ___ ### prices -• **prices**: [`AdminPriceListPricesUpdateReq`](internal-15.AdminPriceListPricesUpdateReq.md)[] +• **prices**: [`AdminPriceListPricesUpdateReq`](internal-17.AdminPriceListPricesUpdateReq.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md rename to docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md index d991fc57c4..0ce71a8aff 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md +++ b/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md @@ -1,12 +1,12 @@ # Class: AdminPostPriceListsPriceListPriceListReq -[internal](../modules/internal-15.md).AdminPostPriceListsPriceListPriceListReq +[internal](../modules/internal-17.md).AdminPostPriceListsPriceListPriceListReq ## Properties ### customer\_groups -• `Optional` **customer\_groups**: [`CustomerGroup`](internal-15.CustomerGroup-1.md)[] +• `Optional` **customer\_groups**: [`CustomerGroup`](internal-17.CustomerGroup-1.md)[] #### Defined in @@ -56,7 +56,7 @@ ___ ### prices -• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-15.AdminPriceListPricesUpdateReq.md)[] +• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-17.AdminPriceListPricesUpdateReq.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListReq.md similarity index 90% rename from docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListReq.md rename to docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListReq.md index 3e4eb2a9ac..9e1805fe73 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListReq.md +++ b/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListReq.md @@ -1,12 +1,12 @@ # Class: AdminPostPriceListsPriceListReq -[internal](../modules/internal-15.md).AdminPostPriceListsPriceListReq +[internal](../modules/internal-17.md).AdminPostPriceListsPriceListReq ## Properties ### customer\_groups -• `Optional` **customer\_groups**: [`CustomerGroup`](internal-15.CustomerGroup.md)[] +• `Optional` **customer\_groups**: [`CustomerGroup`](internal-17.CustomerGroup.md)[] #### Defined in @@ -56,7 +56,7 @@ ___ ### prices -• **prices**: [`AdminPriceListPricesCreateReq`](internal-15.AdminPriceListPricesCreateReq.md)[] +• **prices**: [`AdminPriceListPricesCreateReq`](internal-17.AdminPriceListPricesCreateReq.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-15.AdminPriceListPricesCreateReq.md b/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesCreateReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-15.AdminPriceListPricesCreateReq.md rename to docs/content/references/js-client/classes/internal-17.AdminPriceListPricesCreateReq.md index 9506907704..b65b9f7fae 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminPriceListPricesCreateReq.md +++ b/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesCreateReq.md @@ -1,6 +1,6 @@ # Class: AdminPriceListPricesCreateReq -[internal](../modules/internal-15.md).AdminPriceListPricesCreateReq +[internal](../modules/internal-17.md).AdminPriceListPricesCreateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-15.AdminPriceListPricesUpdateReq.md b/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesUpdateReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-15.AdminPriceListPricesUpdateReq.md rename to docs/content/references/js-client/classes/internal-17.AdminPriceListPricesUpdateReq.md index a11af6eec8..28cdd4fb40 100644 --- a/docs/content/references/js-client/classes/internal-15.AdminPriceListPricesUpdateReq.md +++ b/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesUpdateReq.md @@ -1,6 +1,6 @@ # Class: AdminPriceListPricesUpdateReq -[internal](../modules/internal-15.md).AdminPriceListPricesUpdateReq +[internal](../modules/internal-17.md).AdminPriceListPricesUpdateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-15.CustomerGroup-1.md b/docs/content/references/js-client/classes/internal-17.CustomerGroup-1.md similarity index 74% rename from docs/content/references/js-client/classes/internal-15.CustomerGroup-1.md rename to docs/content/references/js-client/classes/internal-17.CustomerGroup-1.md index 94c15b2d21..92f1378bdf 100644 --- a/docs/content/references/js-client/classes/internal-15.CustomerGroup-1.md +++ b/docs/content/references/js-client/classes/internal-17.CustomerGroup-1.md @@ -1,6 +1,6 @@ # Class: CustomerGroup -[internal](../modules/internal-15.md).CustomerGroup +[internal](../modules/internal-17.md).CustomerGroup ## Properties diff --git a/docs/content/references/js-client/classes/internal-15.CustomerGroup.md b/docs/content/references/js-client/classes/internal-17.CustomerGroup.md similarity index 74% rename from docs/content/references/js-client/classes/internal-15.CustomerGroup.md rename to docs/content/references/js-client/classes/internal-17.CustomerGroup.md index d9f35dd43f..144c177b4b 100644 --- a/docs/content/references/js-client/classes/internal-15.CustomerGroup.md +++ b/docs/content/references/js-client/classes/internal-17.CustomerGroup.md @@ -1,6 +1,6 @@ # Class: CustomerGroup -[internal](../modules/internal-15.md).CustomerGroup +[internal](../modules/internal-17.md).CustomerGroup ## Properties diff --git a/docs/content/references/js-client/classes/internal-15.FilterablePriceListProps.md b/docs/content/references/js-client/classes/internal-17.FilterablePriceListProps.md similarity index 92% rename from docs/content/references/js-client/classes/internal-15.FilterablePriceListProps.md rename to docs/content/references/js-client/classes/internal-17.FilterablePriceListProps.md index 3fd47b32a5..72ba16f006 100644 --- a/docs/content/references/js-client/classes/internal-15.FilterablePriceListProps.md +++ b/docs/content/references/js-client/classes/internal-17.FilterablePriceListProps.md @@ -1,12 +1,12 @@ # Class: FilterablePriceListProps -[internal](../modules/internal-15.md).FilterablePriceListProps +[internal](../modules/internal-17.md).FilterablePriceListProps ## Hierarchy - **`FilterablePriceListProps`** - ↳ [`AdminGetPriceListPaginationParams`](internal-15.AdminGetPriceListPaginationParams.md) + ↳ [`AdminGetPriceListPaginationParams`](internal-17.AdminGetPriceListPaginationParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-16.AdminGetProductTagsPaginationParams.md b/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsPaginationParams.md similarity index 75% rename from docs/content/references/js-client/classes/internal-16.AdminGetProductTagsPaginationParams.md rename to docs/content/references/js-client/classes/internal-18.AdminGetProductTagsPaginationParams.md index 9e4156f6b7..ac21c5b73d 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminGetProductTagsPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsPaginationParams.md @@ -1,12 +1,12 @@ # Class: AdminGetProductTagsPaginationParams -[internal](../modules/internal-16.md).AdminGetProductTagsPaginationParams +[internal](../modules/internal-18.md).AdminGetProductTagsPaginationParams ## Hierarchy - **`AdminGetProductTagsPaginationParams`** - ↳ [`AdminGetProductTagsParams`](internal-16.AdminGetProductTagsParams.md) + ↳ [`AdminGetProductTagsParams`](internal-18.AdminGetProductTagsParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-16.AdminGetProductTagsParams.md b/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsParams.md similarity index 82% rename from docs/content/references/js-client/classes/internal-16.AdminGetProductTagsParams.md rename to docs/content/references/js-client/classes/internal-18.AdminGetProductTagsParams.md index c647400c4a..0fc5b85e6c 100644 --- a/docs/content/references/js-client/classes/internal-16.AdminGetProductTagsParams.md +++ b/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetProductTagsParams -[internal](../modules/internal-16.md).AdminGetProductTagsParams +[internal](../modules/internal-18.md).AdminGetProductTagsParams ## Hierarchy -- [`AdminGetProductTagsPaginationParams`](internal-16.AdminGetProductTagsPaginationParams.md) +- [`AdminGetProductTagsPaginationParams`](internal-18.AdminGetProductTagsPaginationParams.md) ↳ **`AdminGetProductTagsParams`** @@ -46,7 +46,7 @@ ___ #### Inherited from -[AdminGetProductTagsPaginationParams](internal-16.AdminGetProductTagsPaginationParams.md).[limit](internal-16.AdminGetProductTagsPaginationParams.md#limit) +[AdminGetProductTagsPaginationParams](internal-18.AdminGetProductTagsPaginationParams.md).[limit](internal-18.AdminGetProductTagsPaginationParams.md#limit) #### Defined in @@ -60,7 +60,7 @@ ___ #### Inherited from -[AdminGetProductTagsPaginationParams](internal-16.AdminGetProductTagsPaginationParams.md).[offset](internal-16.AdminGetProductTagsPaginationParams.md#offset) +[AdminGetProductTagsPaginationParams](internal-18.AdminGetProductTagsPaginationParams.md).[offset](internal-18.AdminGetProductTagsPaginationParams.md#offset) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-17.AdminGetProductTypesParams.md b/docs/content/references/js-client/classes/internal-19.AdminGetProductTypesParams.md similarity index 96% rename from docs/content/references/js-client/classes/internal-17.AdminGetProductTypesParams.md rename to docs/content/references/js-client/classes/internal-19.AdminGetProductTypesParams.md index a19c9be18a..61607b47d1 100644 --- a/docs/content/references/js-client/classes/internal-17.AdminGetProductTypesParams.md +++ b/docs/content/references/js-client/classes/internal-19.AdminGetProductTypesParams.md @@ -1,6 +1,6 @@ # Class: AdminGetProductTypesParams -[internal](../modules/internal-17.md).AdminGetProductTypesParams +[internal](../modules/internal-19.md).AdminGetProductTypesParams ## Hierarchy diff --git a/docs/content/references/js-client/classes/internal-18.AdminGetProductsParams.md b/docs/content/references/js-client/classes/internal-20.AdminGetProductsParams.md similarity index 59% rename from docs/content/references/js-client/classes/internal-18.AdminGetProductsParams.md rename to docs/content/references/js-client/classes/internal-20.AdminGetProductsParams.md index 45003bdec4..d3fcbb1b0f 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminGetProductsParams.md +++ b/docs/content/references/js-client/classes/internal-20.AdminGetProductsParams.md @@ -1,12 +1,12 @@ # Class: AdminGetProductsParams -[internal](../modules/internal-18.md).AdminGetProductsParams +[internal](../modules/internal-20.md).AdminGetProductsParams API Level DTOs + Validation rules ## Hierarchy -- [`FilterableProductProps`](internal-18.FilterableProductProps.md) +- [`FilterableProductProps`](internal-20.FilterableProductProps.md) ↳ **`AdminGetProductsParams`** @@ -18,7 +18,7 @@ API Level DTOs + Validation rules #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[collection_id](internal-18.FilterableProductProps.md#collection_id) +[FilterableProductProps](internal-20.FilterableProductProps.md).[collection_id](internal-20.FilterableProductProps.md#collection_id) #### Defined in @@ -32,7 +32,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[created_at](internal-18.FilterableProductProps.md#created_at) +[FilterableProductProps](internal-20.FilterableProductProps.md).[created_at](internal-20.FilterableProductProps.md#created_at) #### Defined in @@ -46,7 +46,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[deleted_at](internal-18.FilterableProductProps.md#deleted_at) +[FilterableProductProps](internal-20.FilterableProductProps.md).[deleted_at](internal-20.FilterableProductProps.md#deleted_at) #### Defined in @@ -60,7 +60,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[description](internal-18.FilterableProductProps.md#description) +[FilterableProductProps](internal-20.FilterableProductProps.md).[description](internal-20.FilterableProductProps.md#description) #### Defined in @@ -74,7 +74,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[discount_condition_id](internal-18.FilterableProductProps.md#discount_condition_id) +[FilterableProductProps](internal-20.FilterableProductProps.md).[discount_condition_id](internal-20.FilterableProductProps.md#discount_condition_id) #### Defined in @@ -108,7 +108,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[handle](internal-18.FilterableProductProps.md#handle) +[FilterableProductProps](internal-20.FilterableProductProps.md).[handle](internal-20.FilterableProductProps.md#handle) #### Defined in @@ -122,7 +122,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[id](internal-18.FilterableProductProps.md#id) +[FilterableProductProps](internal-20.FilterableProductProps.md).[id](internal-20.FilterableProductProps.md#id) #### Defined in @@ -136,7 +136,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[is_giftcard](internal-18.FilterableProductProps.md#is_giftcard) +[FilterableProductProps](internal-20.FilterableProductProps.md).[is_giftcard](internal-20.FilterableProductProps.md#is_giftcard) #### Defined in @@ -170,7 +170,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[price_list_id](internal-18.FilterableProductProps.md#price_list_id) +[FilterableProductProps](internal-20.FilterableProductProps.md).[price_list_id](internal-20.FilterableProductProps.md#price_list_id) #### Defined in @@ -184,7 +184,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[q](internal-18.FilterableProductProps.md#q) +[FilterableProductProps](internal-20.FilterableProductProps.md).[q](internal-20.FilterableProductProps.md#q) #### Defined in @@ -198,7 +198,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[sales_channel_id](internal-18.FilterableProductProps.md#sales_channel_id) +[FilterableProductProps](internal-20.FilterableProductProps.md).[sales_channel_id](internal-20.FilterableProductProps.md#sales_channel_id) #### Defined in @@ -212,7 +212,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[status](internal-18.FilterableProductProps.md#status) +[FilterableProductProps](internal-20.FilterableProductProps.md).[status](internal-20.FilterableProductProps.md#status) #### Defined in @@ -226,7 +226,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[tags](internal-18.FilterableProductProps.md#tags) +[FilterableProductProps](internal-20.FilterableProductProps.md).[tags](internal-20.FilterableProductProps.md#tags) #### Defined in @@ -240,7 +240,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[title](internal-18.FilterableProductProps.md#title) +[FilterableProductProps](internal-20.FilterableProductProps.md).[title](internal-20.FilterableProductProps.md#title) #### Defined in @@ -254,7 +254,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[type_id](internal-18.FilterableProductProps.md#type_id) +[FilterableProductProps](internal-20.FilterableProductProps.md).[type_id](internal-20.FilterableProductProps.md#type_id) #### Defined in @@ -268,7 +268,7 @@ ___ #### Inherited from -[FilterableProductProps](internal-18.FilterableProductProps.md).[updated_at](internal-18.FilterableProductProps.md#updated_at) +[FilterableProductProps](internal-20.FilterableProductProps.md).[updated_at](internal-20.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-20.AdminPostProductsProductMetadataReq.md similarity index 82% rename from docs/content/references/js-client/classes/internal-18.AdminPostProductsProductMetadataReq.md rename to docs/content/references/js-client/classes/internal-20.AdminPostProductsProductMetadataReq.md index 9b9f815e28..d8bd611b86 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductMetadataReq.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductMetadataReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductMetadataReq -[internal](../modules/internal-18.md).AdminPostProductsProductMetadataReq +[internal](../modules/internal-20.md).AdminPostProductsProductMetadataReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsOption.md b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsOption.md similarity index 74% rename from docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsOption.md rename to docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsOption.md index 349db82079..1580001aab 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsOption.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsOption.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductOptionsOption -[internal](../modules/internal-18.md).AdminPostProductsProductOptionsOption +[internal](../modules/internal-20.md).AdminPostProductsProductOptionsOption ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsReq.md similarity index 73% rename from docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsReq.md rename to docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsReq.md index 1af93a25b2..0f022a38c7 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsReq.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductOptionsReq -[internal](../modules/internal-18.md).AdminPostProductsProductOptionsReq +[internal](../modules/internal-20.md).AdminPostProductsProductOptionsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductReq.md similarity index 91% rename from docs/content/references/js-client/classes/internal-18.AdminPostProductsProductReq.md rename to docs/content/references/js-client/classes/internal-20.AdminPostProductsProductReq.md index d3430da5b2..72c9bf1468 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductReq.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductReq -[internal](../modules/internal-18.md).AdminPostProductsProductReq +[internal](../modules/internal-20.md).AdminPostProductsProductReq ## Properties @@ -126,7 +126,7 @@ ___ ### sales\_channels -• **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-18.ProductSalesChannelReq.md)[] +• **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-20.ProductSalesChannelReq.md)[] #### Defined in @@ -156,7 +156,7 @@ ___ ### tags -• `Optional` **tags**: [`ProductTagReq`](internal-18.ProductTagReq.md)[] +• `Optional` **tags**: [`ProductTagReq`](internal-20.ProductTagReq.md)[] #### Defined in @@ -186,7 +186,7 @@ ___ ### type -• `Optional` **type**: [`ProductTypeReq`](internal-18.ProductTypeReq.md) +• `Optional` **type**: [`ProductTypeReq`](internal-20.ProductTypeReq.md) #### Defined in @@ -196,7 +196,7 @@ ___ ### variants -• `Optional` **variants**: [`ProductVariantReq`](internal-18.ProductVariantReq-1.md)[] +• `Optional` **variants**: [`ProductVariantReq`](internal-20.ProductVariantReq-1.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsReq.md similarity index 93% rename from docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsReq.md rename to docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsReq.md index 1f7d6f0c31..74047a1148 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsReq.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductVariantsReq -[internal](../modules/internal-18.md).AdminPostProductsProductVariantsReq +[internal](../modules/internal-20.md).AdminPostProductsProductVariantsReq ## Properties @@ -116,7 +116,7 @@ ___ ### options -• **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq.md)[] +• **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq.md)[] #### Defined in @@ -136,7 +136,7 @@ ___ ### prices -• **prices**: [`ProductVariantPricesCreateReq`](internal-18.ProductVariantPricesCreateReq.md)[] +• **prices**: [`ProductVariantPricesCreateReq`](internal-20.ProductVariantPricesCreateReq.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsVariantReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsVariantReq.md similarity index 93% rename from docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsVariantReq.md rename to docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsVariantReq.md index 221949ff6b..709532caf0 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsVariantReq.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsVariantReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsProductVariantsVariantReq -[internal](../modules/internal-18.md).AdminPostProductsProductVariantsVariantReq +[internal](../modules/internal-20.md).AdminPostProductsProductVariantsVariantReq ## Properties @@ -116,7 +116,7 @@ ___ ### options -• **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-1.md)[] +• **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-1.md)[] #### Defined in @@ -136,7 +136,7 @@ ___ ### prices -• **prices**: [`ProductVariantPricesUpdateReq`](internal-18.ProductVariantPricesUpdateReq.md)[] +• **prices**: [`ProductVariantPricesUpdateReq`](internal-20.ProductVariantPricesUpdateReq.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostProductsReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostProductsReq.md similarity index 90% rename from docs/content/references/js-client/classes/internal-18.AdminPostProductsReq.md rename to docs/content/references/js-client/classes/internal-20.AdminPostProductsReq.md index 40af080321..662da22199 100644 --- a/docs/content/references/js-client/classes/internal-18.AdminPostProductsReq.md +++ b/docs/content/references/js-client/classes/internal-20.AdminPostProductsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostProductsReq -[internal](../modules/internal-18.md).AdminPostProductsReq +[internal](../modules/internal-20.md).AdminPostProductsReq ## Properties @@ -126,7 +126,7 @@ ___ ### options -• `Optional` **options**: [`ProductOptionReq`](internal-18.ProductOptionReq.md)[] +• `Optional` **options**: [`ProductOptionReq`](internal-20.ProductOptionReq.md)[] #### Defined in @@ -146,7 +146,7 @@ ___ ### sales\_channels -• `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-18.ProductSalesChannelReq.md)[] +• `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-20.ProductSalesChannelReq.md)[] #### Defined in @@ -176,7 +176,7 @@ ___ ### tags -• `Optional` **tags**: [`ProductTagReq`](internal-18.ProductTagReq.md)[] +• `Optional` **tags**: [`ProductTagReq`](internal-20.ProductTagReq.md)[] #### Defined in @@ -206,7 +206,7 @@ ___ ### type -• `Optional` **type**: [`ProductTypeReq`](internal-18.ProductTypeReq.md) +• `Optional` **type**: [`ProductTypeReq`](internal-20.ProductTypeReq.md) #### Defined in @@ -216,7 +216,7 @@ ___ ### variants -• `Optional` **variants**: [`ProductVariantReq`](internal-18.ProductVariantReq.md)[] +• `Optional` **variants**: [`ProductVariantReq`](internal-20.ProductVariantReq.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-18.FilterableProductProps.md b/docs/content/references/js-client/classes/internal-20.FilterableProductProps.md similarity index 94% rename from docs/content/references/js-client/classes/internal-18.FilterableProductProps.md rename to docs/content/references/js-client/classes/internal-20.FilterableProductProps.md index 0ad6cd1caa..677604ec15 100644 --- a/docs/content/references/js-client/classes/internal-18.FilterableProductProps.md +++ b/docs/content/references/js-client/classes/internal-20.FilterableProductProps.md @@ -1,6 +1,6 @@ # Class: FilterableProductProps -[internal](../modules/internal-18.md).FilterableProductProps +[internal](../modules/internal-20.md).FilterableProductProps API Level DTOs + Validation rules @@ -8,7 +8,7 @@ API Level DTOs + Validation rules - **`FilterableProductProps`** - ↳ [`AdminGetProductsParams`](internal-18.AdminGetProductsParams.md) + ↳ [`AdminGetProductsParams`](internal-20.AdminGetProductsParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductOptionReq.md b/docs/content/references/js-client/classes/internal-20.ProductOptionReq.md similarity index 74% rename from docs/content/references/js-client/classes/internal-18.ProductOptionReq.md rename to docs/content/references/js-client/classes/internal-20.ProductOptionReq.md index 342c49c608..b85ad8d068 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductOptionReq.md +++ b/docs/content/references/js-client/classes/internal-20.ProductOptionReq.md @@ -1,6 +1,6 @@ # Class: ProductOptionReq -[internal](../modules/internal-18.md).ProductOptionReq +[internal](../modules/internal-20.md).ProductOptionReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductSalesChannelReq.md b/docs/content/references/js-client/classes/internal-20.ProductSalesChannelReq.md similarity index 68% rename from docs/content/references/js-client/classes/internal-18.ProductSalesChannelReq.md rename to docs/content/references/js-client/classes/internal-20.ProductSalesChannelReq.md index 1938ac6b46..fbc5c4910b 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductSalesChannelReq.md +++ b/docs/content/references/js-client/classes/internal-20.ProductSalesChannelReq.md @@ -1,6 +1,6 @@ # Class: ProductSalesChannelReq -[internal](../modules/internal-18.md).ProductSalesChannelReq +[internal](../modules/internal-20.md).ProductSalesChannelReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductTagReq.md b/docs/content/references/js-client/classes/internal-20.ProductTagReq.md similarity index 81% rename from docs/content/references/js-client/classes/internal-18.ProductTagReq.md rename to docs/content/references/js-client/classes/internal-20.ProductTagReq.md index fbf3779c08..f1515df2db 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductTagReq.md +++ b/docs/content/references/js-client/classes/internal-20.ProductTagReq.md @@ -1,6 +1,6 @@ # Class: ProductTagReq -[internal](../modules/internal-18.md).ProductTagReq +[internal](../modules/internal-20.md).ProductTagReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductTypeReq.md b/docs/content/references/js-client/classes/internal-20.ProductTypeReq.md similarity index 81% rename from docs/content/references/js-client/classes/internal-18.ProductTypeReq.md rename to docs/content/references/js-client/classes/internal-20.ProductTypeReq.md index 35b97c6a15..2db35b8fa6 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductTypeReq.md +++ b/docs/content/references/js-client/classes/internal-20.ProductTypeReq.md @@ -1,6 +1,6 @@ # Class: ProductTypeReq -[internal](../modules/internal-18.md).ProductTypeReq +[internal](../modules/internal-20.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-20.ProductVariantOptionReq-1.md similarity index 82% rename from docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-1.md rename to docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-1.md index 52fbba014d..0043a67ea2 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-1.md +++ b/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-1.md @@ -1,6 +1,6 @@ # Class: ProductVariantOptionReq -[internal](../modules/internal-18.md).ProductVariantOptionReq +[internal](../modules/internal-20.md).ProductVariantOptionReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-2.md b/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-2.md similarity index 72% rename from docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-2.md rename to docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-2.md index e24761d83e..ed255e39c6 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-2.md +++ b/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-2.md @@ -1,6 +1,6 @@ # Class: ProductVariantOptionReq -[internal](../modules/internal-18.md).ProductVariantOptionReq +[internal](../modules/internal-20.md).ProductVariantOptionReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-3.md b/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-3.md similarity index 82% rename from docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-3.md rename to docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-3.md index cd2f3f15b7..7d423d0287 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-3.md +++ b/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-3.md @@ -1,6 +1,6 @@ # Class: ProductVariantOptionReq -[internal](../modules/internal-18.md).ProductVariantOptionReq +[internal](../modules/internal-20.md).ProductVariantOptionReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq.md b/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq.md similarity index 82% rename from docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq.md rename to docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq.md index 222ddbcecb..6eb83c094f 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq.md +++ b/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq.md @@ -1,6 +1,6 @@ # Class: ProductVariantOptionReq -[internal](../modules/internal-18.md).ProductVariantOptionReq +[internal](../modules/internal-20.md).ProductVariantOptionReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantPricesCreateReq.md b/docs/content/references/js-client/classes/internal-20.ProductVariantPricesCreateReq.md similarity index 91% rename from docs/content/references/js-client/classes/internal-18.ProductVariantPricesCreateReq.md rename to docs/content/references/js-client/classes/internal-20.ProductVariantPricesCreateReq.md index 3fcdca0784..5ac40ce858 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductVariantPricesCreateReq.md +++ b/docs/content/references/js-client/classes/internal-20.ProductVariantPricesCreateReq.md @@ -1,6 +1,6 @@ # Class: ProductVariantPricesCreateReq -[internal](../modules/internal-18.md).ProductVariantPricesCreateReq +[internal](../modules/internal-20.md).ProductVariantPricesCreateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantPricesUpdateReq.md b/docs/content/references/js-client/classes/internal-20.ProductVariantPricesUpdateReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-18.ProductVariantPricesUpdateReq.md rename to docs/content/references/js-client/classes/internal-20.ProductVariantPricesUpdateReq.md index a31ff329a9..13eed0205e 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductVariantPricesUpdateReq.md +++ b/docs/content/references/js-client/classes/internal-20.ProductVariantPricesUpdateReq.md @@ -1,6 +1,6 @@ # Class: ProductVariantPricesUpdateReq -[internal](../modules/internal-18.md).ProductVariantPricesUpdateReq +[internal](../modules/internal-20.md).ProductVariantPricesUpdateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantReq-1.md b/docs/content/references/js-client/classes/internal-20.ProductVariantReq-1.md similarity index 94% rename from docs/content/references/js-client/classes/internal-18.ProductVariantReq-1.md rename to docs/content/references/js-client/classes/internal-20.ProductVariantReq-1.md index db681df7d4..951a62d0f3 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductVariantReq-1.md +++ b/docs/content/references/js-client/classes/internal-20.ProductVariantReq-1.md @@ -1,6 +1,6 @@ # Class: ProductVariantReq -[internal](../modules/internal-18.md).ProductVariantReq +[internal](../modules/internal-20.md).ProductVariantReq ## Properties @@ -126,7 +126,7 @@ ___ ### options -• `Optional` **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-3.md)[] +• `Optional` **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-3.md)[] #### Defined in @@ -146,7 +146,7 @@ ___ ### prices -• **prices**: [`ProductVariantPricesUpdateReq`](internal-18.ProductVariantPricesUpdateReq.md)[] +• **prices**: [`ProductVariantPricesUpdateReq`](internal-20.ProductVariantPricesUpdateReq.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-18.ProductVariantReq.md b/docs/content/references/js-client/classes/internal-20.ProductVariantReq.md similarity index 94% rename from docs/content/references/js-client/classes/internal-18.ProductVariantReq.md rename to docs/content/references/js-client/classes/internal-20.ProductVariantReq.md index db2d3ebdb6..363b3ee7f6 100644 --- a/docs/content/references/js-client/classes/internal-18.ProductVariantReq.md +++ b/docs/content/references/js-client/classes/internal-20.ProductVariantReq.md @@ -1,6 +1,6 @@ # Class: ProductVariantReq -[internal](../modules/internal-18.md).ProductVariantReq +[internal](../modules/internal-20.md).ProductVariantReq ## Properties @@ -116,7 +116,7 @@ ___ ### options -• `Optional` **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-2.md)[] +• `Optional` **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-2.md)[] #### Defined in @@ -136,7 +136,7 @@ ___ ### prices -• **prices**: [`ProductVariantPricesCreateReq`](internal-18.ProductVariantPricesCreateReq.md)[] +• **prices**: [`ProductVariantPricesCreateReq`](internal-20.ProductVariantPricesCreateReq.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md b/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md new file mode 100644 index 0000000000..7fee3ab5eb --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostPublishableApiKeysPublishableApiKeyReq + +[internal](../modules/internal-21.md).AdminPostPublishableApiKeysPublishableApiKeyReq + +## Properties + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/publishable-api-keys/update-publishable-api-key.d.ts:70 diff --git a/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysReq.md b/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysReq.md new file mode 100644 index 0000000000..1e63d26b14 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostPublishableApiKeysReq + +[internal](../modules/internal-21.md).AdminPostPublishableApiKeysReq + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/publishable-api-keys/create-publishable-api-key.d.ts:65 diff --git a/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeysParams.md b/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeysParams.md new file mode 100644 index 0000000000..50ab9eae4f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeysParams.md @@ -0,0 +1,75 @@ +# Class: GetPublishableApiKeysParams + +[internal](../modules/internal-21.md).GetPublishableApiKeysParams + +## Hierarchy + +- [`GetPublishableApiKeysParams_base`](../modules/internal-21.md#getpublishableapikeysparams_base) + + ↳ **`GetPublishableApiKeysParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +GetPublishableApiKeysParams\_base.expand + +#### Defined in + +medusa/dist/types/common.d.ts:117 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +GetPublishableApiKeysParams\_base.fields + +#### Defined in + +medusa/dist/types/common.d.ts:118 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +GetPublishableApiKeysParams\_base.limit + +#### Defined in + +medusa/dist/types/common.d.ts:122 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +GetPublishableApiKeysParams\_base.offset + +#### Defined in + +medusa/dist/types/common.d.ts:121 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:62 diff --git a/docs/content/references/js-client/classes/internal-21.PublishableApiKey.md b/docs/content/references/js-client/classes/internal-21.PublishableApiKey.md new file mode 100644 index 0000000000..9b360d2a59 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.PublishableApiKey.md @@ -0,0 +1,103 @@ +# Class: PublishableApiKey + +[internal](../modules/internal-21.md).PublishableApiKey + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal.BaseEntity.md) + + ↳ **`PublishableApiKey`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +medusa/dist/models/publishable-api-key.d.ts:7 + +___ + +### 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**: ``null`` \| `string` + +#### Defined in + +medusa/dist/models/publishable-api-key.d.ts:3 + +___ + +### 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 + +___ + +### revoked\_at + +• `Optional` **revoked\_at**: `Date` + +#### Defined in + +medusa/dist/models/publishable-api-key.d.ts:5 + +___ + +### revoked\_by + +• **revoked\_by**: ``null`` \| `string` + +#### Defined in + +medusa/dist/models/publishable-api-key.d.ts:4 + +___ + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/models/publishable-api-key.d.ts:6 + +___ + +### 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 diff --git a/docs/content/references/js-client/classes/internal-19.AdminGetRegionsPaginationParams.md b/docs/content/references/js-client/classes/internal-22.AdminGetRegionsPaginationParams.md similarity index 74% rename from docs/content/references/js-client/classes/internal-19.AdminGetRegionsPaginationParams.md rename to docs/content/references/js-client/classes/internal-22.AdminGetRegionsPaginationParams.md index ba505427c7..a101234c60 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminGetRegionsPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-22.AdminGetRegionsPaginationParams.md @@ -1,12 +1,12 @@ # Class: AdminGetRegionsPaginationParams -[internal](../modules/internal-19.md).AdminGetRegionsPaginationParams +[internal](../modules/internal-22.md).AdminGetRegionsPaginationParams ## Hierarchy - **`AdminGetRegionsPaginationParams`** - ↳ [`AdminGetRegionsParams`](internal-19.AdminGetRegionsParams.md) + ↳ [`AdminGetRegionsParams`](internal-22.AdminGetRegionsParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-19.AdminGetRegionsParams.md b/docs/content/references/js-client/classes/internal-22.AdminGetRegionsParams.md similarity index 73% rename from docs/content/references/js-client/classes/internal-19.AdminGetRegionsParams.md rename to docs/content/references/js-client/classes/internal-22.AdminGetRegionsParams.md index bd2775dfcc..c6581efdb8 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminGetRegionsParams.md +++ b/docs/content/references/js-client/classes/internal-22.AdminGetRegionsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetRegionsParams -[internal](../modules/internal-19.md).AdminGetRegionsParams +[internal](../modules/internal-22.md).AdminGetRegionsParams ## Hierarchy -- [`AdminGetRegionsPaginationParams`](internal-19.AdminGetRegionsPaginationParams.md) +- [`AdminGetRegionsPaginationParams`](internal-22.AdminGetRegionsPaginationParams.md) ↳ **`AdminGetRegionsParams`** @@ -36,7 +36,7 @@ ___ #### Inherited from -[AdminGetRegionsPaginationParams](internal-19.AdminGetRegionsPaginationParams.md).[limit](internal-19.AdminGetRegionsPaginationParams.md#limit) +[AdminGetRegionsPaginationParams](internal-22.AdminGetRegionsPaginationParams.md).[limit](internal-22.AdminGetRegionsPaginationParams.md#limit) #### Defined in @@ -50,7 +50,7 @@ ___ #### Inherited from -[AdminGetRegionsPaginationParams](internal-19.AdminGetRegionsPaginationParams.md).[offset](internal-19.AdminGetRegionsPaginationParams.md#offset) +[AdminGetRegionsPaginationParams](internal-22.AdminGetRegionsPaginationParams.md).[offset](internal-22.AdminGetRegionsPaginationParams.md#offset) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md b/docs/content/references/js-client/classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md similarity index 61% rename from docs/content/references/js-client/classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md rename to docs/content/references/js-client/classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md index 988f6d0487..cddff07b98 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md +++ b/docs/content/references/js-client/classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md @@ -1,12 +1,12 @@ # Class: AdminGetRegionsRegionFulfillmentOptionsRes -[internal](../modules/internal-19.md).AdminGetRegionsRegionFulfillmentOptionsRes +[internal](../modules/internal-22.md).AdminGetRegionsRegionFulfillmentOptionsRes ## Properties ### fulfillment\_options -• **fulfillment\_options**: [`FulfillmentOption`](internal-19.FulfillmentOption.md)[] +• **fulfillment\_options**: [`FulfillmentOption`](internal-22.FulfillmentOption.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionCountriesReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionCountriesReq.md similarity index 75% rename from docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionCountriesReq.md rename to docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionCountriesReq.md index 4775f1901c..7920b5a6b3 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionCountriesReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionCountriesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsRegionCountriesReq -[internal](../modules/internal-19.md).AdminPostRegionsRegionCountriesReq +[internal](../modules/internal-22.md).AdminPostRegionsRegionCountriesReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md similarity index 78% rename from docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md rename to docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md index 46ab825913..8f804fc377 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsRegionFulfillmentProvidersReq -[internal](../modules/internal-19.md).AdminPostRegionsRegionFulfillmentProvidersReq +[internal](../modules/internal-22.md).AdminPostRegionsRegionFulfillmentProvidersReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md similarity index 77% rename from docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md rename to docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md index e193256e63..04f5148eed 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsRegionPaymentProvidersReq -[internal](../modules/internal-19.md).AdminPostRegionsRegionPaymentProvidersReq +[internal](../modules/internal-22.md).AdminPostRegionsRegionPaymentProvidersReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionReq.md similarity index 96% rename from docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionReq.md rename to docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionReq.md index 749cf66d20..92e171b00f 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsRegionReq -[internal](../modules/internal-19.md).AdminPostRegionsRegionReq +[internal](../modules/internal-22.md).AdminPostRegionsRegionReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsReq.md similarity index 95% rename from docs/content/references/js-client/classes/internal-19.AdminPostRegionsReq.md rename to docs/content/references/js-client/classes/internal-22.AdminPostRegionsReq.md index fa4b6da7b2..e92bd12e12 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminPostRegionsReq.md +++ b/docs/content/references/js-client/classes/internal-22.AdminPostRegionsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostRegionsReq -[internal](../modules/internal-19.md).AdminPostRegionsReq +[internal](../modules/internal-22.md).AdminPostRegionsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-19.AdminRegionsRes.md b/docs/content/references/js-client/classes/internal-22.AdminRegionsRes.md similarity index 75% rename from docs/content/references/js-client/classes/internal-19.AdminRegionsRes.md rename to docs/content/references/js-client/classes/internal-22.AdminRegionsRes.md index dafe699bd4..fac35d4120 100644 --- a/docs/content/references/js-client/classes/internal-19.AdminRegionsRes.md +++ b/docs/content/references/js-client/classes/internal-22.AdminRegionsRes.md @@ -1,6 +1,6 @@ # Class: AdminRegionsRes -[internal](../modules/internal-19.md).AdminRegionsRes +[internal](../modules/internal-22.md).AdminRegionsRes ## Properties diff --git a/docs/content/references/js-client/classes/internal-19.FulfillmentOption.md b/docs/content/references/js-client/classes/internal-22.FulfillmentOption.md similarity index 83% rename from docs/content/references/js-client/classes/internal-19.FulfillmentOption.md rename to docs/content/references/js-client/classes/internal-22.FulfillmentOption.md index b96388c8e4..7245dd9743 100644 --- a/docs/content/references/js-client/classes/internal-19.FulfillmentOption.md +++ b/docs/content/references/js-client/classes/internal-22.FulfillmentOption.md @@ -1,6 +1,6 @@ # Class: FulfillmentOption -[internal](../modules/internal-19.md).FulfillmentOption +[internal](../modules/internal-22.md).FulfillmentOption ## Properties diff --git a/docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReasonReq.md b/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReasonReq.md similarity index 90% rename from docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReasonReq.md rename to docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReasonReq.md index 9aa35e6e3a..33b9548bf4 100644 --- a/docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReasonReq.md +++ b/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReasonReq.md @@ -1,6 +1,6 @@ # Class: AdminPostReturnReasonsReasonReq -[internal](../modules/internal-20.md).AdminPostReturnReasonsReasonReq +[internal](../modules/internal-23.md).AdminPostReturnReasonsReasonReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReq.md b/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReq.md rename to docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReq.md index 34ba6fa6b7..6f8d2c5980 100644 --- a/docs/content/references/js-client/classes/internal-20.AdminPostReturnReasonsReq.md +++ b/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostReturnReasonsReq -[internal](../modules/internal-20.md).AdminPostReturnReasonsReq +[internal](../modules/internal-23.md).AdminPostReturnReasonsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-21.AdminGetReturnsParams.md b/docs/content/references/js-client/classes/internal-24.AdminGetReturnsParams.md similarity index 83% rename from docs/content/references/js-client/classes/internal-21.AdminGetReturnsParams.md rename to docs/content/references/js-client/classes/internal-24.AdminGetReturnsParams.md index b63d08a23b..f34e944321 100644 --- a/docs/content/references/js-client/classes/internal-21.AdminGetReturnsParams.md +++ b/docs/content/references/js-client/classes/internal-24.AdminGetReturnsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetReturnsParams -[internal](../modules/internal-21.md).AdminGetReturnsParams +[internal](../modules/internal-24.md).AdminGetReturnsParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-21.AdminPostReturnsReturnReceiveReq.md b/docs/content/references/js-client/classes/internal-24.AdminPostReturnsReturnReceiveReq.md similarity index 72% rename from docs/content/references/js-client/classes/internal-21.AdminPostReturnsReturnReceiveReq.md rename to docs/content/references/js-client/classes/internal-24.AdminPostReturnsReturnReceiveReq.md index 6dbac98fa3..a1f7ea4b20 100644 --- a/docs/content/references/js-client/classes/internal-21.AdminPostReturnsReturnReceiveReq.md +++ b/docs/content/references/js-client/classes/internal-24.AdminPostReturnsReturnReceiveReq.md @@ -1,12 +1,12 @@ # Class: AdminPostReturnsReturnReceiveReq -[internal](../modules/internal-21.md).AdminPostReturnsReturnReceiveReq +[internal](../modules/internal-24.md).AdminPostReturnsReturnReceiveReq ## Properties ### items -• **items**: [`Item`](internal-21.Item.md)[] +• **items**: [`Item`](internal-24.Item.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-21.Item.md b/docs/content/references/js-client/classes/internal-24.Item.md similarity index 86% rename from docs/content/references/js-client/classes/internal-21.Item.md rename to docs/content/references/js-client/classes/internal-24.Item.md index f9d349f418..29b1073101 100644 --- a/docs/content/references/js-client/classes/internal-21.Item.md +++ b/docs/content/references/js-client/classes/internal-24.Item.md @@ -1,6 +1,6 @@ # Class: Item -[internal](../modules/internal-21.md).Item +[internal](../modules/internal-24.md).Item ## Properties diff --git a/docs/content/references/js-client/classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md b/docs/content/references/js-client/classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md similarity index 64% rename from docs/content/references/js-client/classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md rename to docs/content/references/js-client/classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md index ebb8ebaa68..796cac9f0f 100644 --- a/docs/content/references/js-client/classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md +++ b/docs/content/references/js-client/classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md @@ -1,12 +1,12 @@ # Class: AdminDeleteSalesChannelsChannelProductsBatchReq -[internal](../modules/internal-22.md).AdminDeleteSalesChannelsChannelProductsBatchReq +[internal](../modules/internal-25.md).AdminDeleteSalesChannelsChannelProductsBatchReq ## Properties ### product\_ids -• **product\_ids**: [`ProductBatchSalesChannel`](internal-22.ProductBatchSalesChannel.md)[] +• **product\_ids**: [`ProductBatchSalesChannel`](internal-25.ProductBatchSalesChannel.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-22.AdminGetSalesChannelsParams.md b/docs/content/references/js-client/classes/internal-25.AdminGetSalesChannelsParams.md similarity index 94% rename from docs/content/references/js-client/classes/internal-22.AdminGetSalesChannelsParams.md rename to docs/content/references/js-client/classes/internal-25.AdminGetSalesChannelsParams.md index e05b0dd0e5..e48f176cb2 100644 --- a/docs/content/references/js-client/classes/internal-22.AdminGetSalesChannelsParams.md +++ b/docs/content/references/js-client/classes/internal-25.AdminGetSalesChannelsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetSalesChannelsParams -[internal](../modules/internal-22.md).AdminGetSalesChannelsParams +[internal](../modules/internal-25.md).AdminGetSalesChannelsParams ## Hierarchy -- [`AdminGetSalesChannelsParams_base`](../modules/internal-22.md#admingetsaleschannelsparams_base) +- [`AdminGetSalesChannelsParams_base`](../modules/internal-25.md#admingetsaleschannelsparams_base) ↳ **`AdminGetSalesChannelsParams`** diff --git a/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md similarity index 64% rename from docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md rename to docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md index ea5b24579e..e181338c26 100644 --- a/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md +++ b/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md @@ -1,12 +1,12 @@ # Class: AdminPostSalesChannelsChannelProductsBatchReq -[internal](../modules/internal-22.md).AdminPostSalesChannelsChannelProductsBatchReq +[internal](../modules/internal-25.md).AdminPostSalesChannelsChannelProductsBatchReq ## Properties ### product\_ids -• **product\_ids**: [`ProductBatchSalesChannel`](internal-22.ProductBatchSalesChannel.md)[] +• **product\_ids**: [`ProductBatchSalesChannel`](internal-25.ProductBatchSalesChannel.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsReq.md similarity index 88% rename from docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsReq.md rename to docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsReq.md index 9cc185bce9..64af2c7abc 100644 --- a/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsReq.md +++ b/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostSalesChannelsReq -[internal](../modules/internal-22.md).AdminPostSalesChannelsReq +[internal](../modules/internal-25.md).AdminPostSalesChannelsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md similarity index 89% rename from docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md rename to docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md index 224aab73b1..5737c27434 100644 --- a/docs/content/references/js-client/classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md +++ b/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md @@ -1,6 +1,6 @@ # Class: AdminPostSalesChannelsSalesChannelReq -[internal](../modules/internal-22.md).AdminPostSalesChannelsSalesChannelReq +[internal](../modules/internal-25.md).AdminPostSalesChannelsSalesChannelReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-22.ProductBatchSalesChannel.md b/docs/content/references/js-client/classes/internal-25.ProductBatchSalesChannel.md similarity index 68% rename from docs/content/references/js-client/classes/internal-22.ProductBatchSalesChannel.md rename to docs/content/references/js-client/classes/internal-25.ProductBatchSalesChannel.md index efe2ab72e2..0013d094f9 100644 --- a/docs/content/references/js-client/classes/internal-22.ProductBatchSalesChannel.md +++ b/docs/content/references/js-client/classes/internal-25.ProductBatchSalesChannel.md @@ -1,6 +1,6 @@ # Class: ProductBatchSalesChannel -[internal](../modules/internal-22.md).ProductBatchSalesChannel +[internal](../modules/internal-25.md).ProductBatchSalesChannel ## Properties diff --git a/docs/content/references/js-client/classes/internal-23.AdminGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-26.AdminGetShippingOptionsParams.md similarity index 89% rename from docs/content/references/js-client/classes/internal-23.AdminGetShippingOptionsParams.md rename to docs/content/references/js-client/classes/internal-26.AdminGetShippingOptionsParams.md index 9a5287e13a..ccb6c59565 100644 --- a/docs/content/references/js-client/classes/internal-23.AdminGetShippingOptionsParams.md +++ b/docs/content/references/js-client/classes/internal-26.AdminGetShippingOptionsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetShippingOptionsParams -[internal](../modules/internal-23.md).AdminGetShippingOptionsParams +[internal](../modules/internal-26.md).AdminGetShippingOptionsParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsOptionReq.md b/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsOptionReq.md similarity index 88% rename from docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsOptionReq.md rename to docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsOptionReq.md index 6da7a125ab..6cbd32839e 100644 --- a/docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsOptionReq.md +++ b/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsOptionReq.md @@ -1,6 +1,6 @@ # Class: AdminPostShippingOptionsOptionReq -[internal](../modules/internal-23.md).AdminPostShippingOptionsOptionReq +[internal](../modules/internal-26.md).AdminPostShippingOptionsOptionReq ## Properties @@ -56,7 +56,7 @@ ___ ### requirements -• **requirements**: [`OptionRequirement`](internal-23.OptionRequirement-1.md)[] +• **requirements**: [`OptionRequirement`](internal-26.OptionRequirement-1.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsReq.md similarity index 95% rename from docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsReq.md rename to docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsReq.md index d3dbfcbdb5..8ca0ef3558 100644 --- a/docs/content/references/js-client/classes/internal-23.AdminPostShippingOptionsReq.md +++ b/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostShippingOptionsReq -[internal](../modules/internal-23.md).AdminPostShippingOptionsReq +[internal](../modules/internal-26.md).AdminPostShippingOptionsReq ## Properties @@ -116,7 +116,7 @@ ___ ### requirements -• `Optional` **requirements**: [`OptionRequirement`](internal-23.OptionRequirement.md)[] +• `Optional` **requirements**: [`OptionRequirement`](internal-26.OptionRequirement.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-23.OptionRequirement-1.md b/docs/content/references/js-client/classes/internal-26.OptionRequirement-1.md similarity index 88% rename from docs/content/references/js-client/classes/internal-23.OptionRequirement-1.md rename to docs/content/references/js-client/classes/internal-26.OptionRequirement-1.md index d03d0a526e..aa91f9cf47 100644 --- a/docs/content/references/js-client/classes/internal-23.OptionRequirement-1.md +++ b/docs/content/references/js-client/classes/internal-26.OptionRequirement-1.md @@ -1,6 +1,6 @@ # Class: OptionRequirement -[internal](../modules/internal-23.md).OptionRequirement +[internal](../modules/internal-26.md).OptionRequirement ## Properties diff --git a/docs/content/references/js-client/classes/internal-23.OptionRequirement.md b/docs/content/references/js-client/classes/internal-26.OptionRequirement.md similarity index 84% rename from docs/content/references/js-client/classes/internal-23.OptionRequirement.md rename to docs/content/references/js-client/classes/internal-26.OptionRequirement.md index ceed145625..b6a1863426 100644 --- a/docs/content/references/js-client/classes/internal-23.OptionRequirement.md +++ b/docs/content/references/js-client/classes/internal-26.OptionRequirement.md @@ -1,6 +1,6 @@ # Class: OptionRequirement -[internal](../modules/internal-23.md).OptionRequirement +[internal](../modules/internal-26.md).OptionRequirement ## Properties diff --git a/docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesProfileReq.md b/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesProfileReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesProfileReq.md rename to docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesProfileReq.md index 67d9277c7a..18c652724c 100644 --- a/docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesProfileReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesProfileReq.md @@ -1,6 +1,6 @@ # Class: AdminPostShippingProfilesProfileReq -[internal](../modules/internal-24.md).AdminPostShippingProfilesProfileReq +[internal](../modules/internal-27.md).AdminPostShippingProfilesProfileReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesReq.md b/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesReq.md similarity index 74% rename from docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesReq.md rename to docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesReq.md index 4943d416ba..62d38eef05 100644 --- a/docs/content/references/js-client/classes/internal-24.AdminPostShippingProfilesReq.md +++ b/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostShippingProfilesReq -[internal](../modules/internal-24.md).AdminPostShippingProfilesReq +[internal](../modules/internal-27.md).AdminPostShippingProfilesReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostStoreReq.md b/docs/content/references/js-client/classes/internal-28.AdminPostStoreReq.md similarity index 95% rename from docs/content/references/js-client/classes/internal-25.AdminPostStoreReq.md rename to docs/content/references/js-client/classes/internal-28.AdminPostStoreReq.md index e4a7a271c2..ba0da6abb3 100644 --- a/docs/content/references/js-client/classes/internal-25.AdminPostStoreReq.md +++ b/docs/content/references/js-client/classes/internal-28.AdminPostStoreReq.md @@ -1,6 +1,6 @@ # Class: AdminPostStoreReq -[internal](../modules/internal-25.md).AdminPostStoreReq +[internal](../modules/internal-28.md).AdminPostStoreReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-25.Store.md b/docs/content/references/js-client/classes/internal-28.Store.md similarity index 98% rename from docs/content/references/js-client/classes/internal-25.Store.md rename to docs/content/references/js-client/classes/internal-28.Store.md index 57130dc905..31d009b31d 100644 --- a/docs/content/references/js-client/classes/internal-25.Store.md +++ b/docs/content/references/js-client/classes/internal-28.Store.md @@ -1,6 +1,6 @@ # Class: Store -[internal](../modules/internal-25.md).Store +[internal](../modules/internal-28.md).Store Base abstract entity for all entities diff --git a/docs/content/references/js-client/classes/internal-26.AdminGetSwapsParams.md b/docs/content/references/js-client/classes/internal-29.AdminGetSwapsParams.md similarity index 83% rename from docs/content/references/js-client/classes/internal-26.AdminGetSwapsParams.md rename to docs/content/references/js-client/classes/internal-29.AdminGetSwapsParams.md index a58a125aee..2fd8122013 100644 --- a/docs/content/references/js-client/classes/internal-26.AdminGetSwapsParams.md +++ b/docs/content/references/js-client/classes/internal-29.AdminGetSwapsParams.md @@ -1,6 +1,6 @@ # Class: AdminGetSwapsParams -[internal](../modules/internal-26.md).AdminGetSwapsParams +[internal](../modules/internal-29.md).AdminGetSwapsParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md similarity index 85% rename from docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md rename to docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md index 8a049f9184..e808279786 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md +++ b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateProductTypesParams -[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateProductTypesParams +[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateProductTypesParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md similarity index 78% rename from docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md rename to docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md index 53647b0041..bdfa885b51 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md +++ b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateProductTypesReq -[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateProductTypesReq +[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateProductTypesReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md similarity index 84% rename from docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md rename to docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md index e4eef13a20..f047faa4dd 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md +++ b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateProductsParams -[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateProductsParams +[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateProductsParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md rename to docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md index c4bad115df..c5c7706f33 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md +++ b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateProductsReq -[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateProductsReq +[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateProductsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md similarity index 85% rename from docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md rename to docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md index faee9a80b3..198905b9b5 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md +++ b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateShippingOptionsParams -[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams +[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md similarity index 79% rename from docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md rename to docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md index e550db229a..1a074924b7 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md +++ b/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md @@ -1,6 +1,6 @@ # Class: AdminDeleteTaxRatesTaxRateShippingOptionsReq -[internal](../modules/internal-27.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq +[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesParams.md b/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesParams.md similarity index 91% rename from docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesParams.md rename to docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesParams.md index 0b7ec15273..227cdee594 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesParams.md +++ b/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesParams.md @@ -1,6 +1,6 @@ # Class: AdminGetTaxRatesParams -[internal](../modules/internal-27.md).AdminGetTaxRatesParams +[internal](../modules/internal-30.md).AdminGetTaxRatesParams ## Properties @@ -66,7 +66,7 @@ ___ ### rate -• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal-27.NumericalComparisonOperator.md) +• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal-30.NumericalComparisonOperator.md) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesTaxRateParams.md b/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesTaxRateParams.md similarity index 83% rename from docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesTaxRateParams.md rename to docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesTaxRateParams.md index 1884565119..33652119a6 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminGetTaxRatesTaxRateParams.md +++ b/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesTaxRateParams.md @@ -1,6 +1,6 @@ # Class: AdminGetTaxRatesTaxRateParams -[internal](../modules/internal-27.md).AdminGetTaxRatesTaxRateParams +[internal](../modules/internal-30.md).AdminGetTaxRatesTaxRateParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesReq.md b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesReq.md similarity index 94% rename from docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesReq.md rename to docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesReq.md index c34d50674c..8fbd005c06 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesReq.md +++ b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesReq -[internal](../modules/internal-27.md).AdminPostTaxRatesReq +[internal](../modules/internal-30.md).AdminPostTaxRatesReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md similarity index 77% rename from docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md rename to docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md index 88180339a3..d1b01e277e 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md +++ b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesTaxRateProductTypesReq -[internal](../modules/internal-27.md).AdminPostTaxRatesTaxRateProductTypesReq +[internal](../modules/internal-30.md).AdminPostTaxRatesTaxRateProductTypesReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md similarity index 75% rename from docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md rename to docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md index 61e075a9ab..e3c70e8614 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md +++ b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesTaxRateProductsReq -[internal](../modules/internal-27.md).AdminPostTaxRatesTaxRateProductsReq +[internal](../modules/internal-30.md).AdminPostTaxRatesTaxRateProductsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateReq.md b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateReq.md similarity index 94% rename from docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateReq.md rename to docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateReq.md index c14842feea..61555c467b 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateReq.md +++ b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesTaxRateReq -[internal](../modules/internal-27.md).AdminPostTaxRatesTaxRateReq +[internal](../modules/internal-30.md).AdminPostTaxRatesTaxRateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md similarity index 78% rename from docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md rename to docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md index c4cad16bc8..ecfa14e448 100644 --- a/docs/content/references/js-client/classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md +++ b/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md @@ -1,6 +1,6 @@ # Class: AdminPostTaxRatesTaxRateShippingOptionsReq -[internal](../modules/internal-27.md).AdminPostTaxRatesTaxRateShippingOptionsReq +[internal](../modules/internal-30.md).AdminPostTaxRatesTaxRateShippingOptionsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-27.NumericalComparisonOperator.md b/docs/content/references/js-client/classes/internal-30.NumericalComparisonOperator.md similarity index 87% rename from docs/content/references/js-client/classes/internal-27.NumericalComparisonOperator.md rename to docs/content/references/js-client/classes/internal-30.NumericalComparisonOperator.md index 988630f6e5..5352eeb119 100644 --- a/docs/content/references/js-client/classes/internal-27.NumericalComparisonOperator.md +++ b/docs/content/references/js-client/classes/internal-30.NumericalComparisonOperator.md @@ -1,6 +1,6 @@ # Class: NumericalComparisonOperator -[internal](../modules/internal-27.md).NumericalComparisonOperator +[internal](../modules/internal-30.md).NumericalComparisonOperator ## Properties diff --git a/docs/content/references/js-client/classes/internal-28.AdminDeleteUploadsReq.md b/docs/content/references/js-client/classes/internal-31.AdminDeleteUploadsReq.md similarity index 73% rename from docs/content/references/js-client/classes/internal-28.AdminDeleteUploadsReq.md rename to docs/content/references/js-client/classes/internal-31.AdminDeleteUploadsReq.md index c862de3ab0..77496887de 100644 --- a/docs/content/references/js-client/classes/internal-28.AdminDeleteUploadsReq.md +++ b/docs/content/references/js-client/classes/internal-31.AdminDeleteUploadsReq.md @@ -1,6 +1,6 @@ # Class: AdminDeleteUploadsReq -[internal](../modules/internal-28.md).AdminDeleteUploadsReq +[internal](../modules/internal-31.md).AdminDeleteUploadsReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-28.AdminPostUploadsDownloadUrlReq.md b/docs/content/references/js-client/classes/internal-31.AdminPostUploadsDownloadUrlReq.md similarity index 74% rename from docs/content/references/js-client/classes/internal-28.AdminPostUploadsDownloadUrlReq.md rename to docs/content/references/js-client/classes/internal-31.AdminPostUploadsDownloadUrlReq.md index b1076adb17..1b92af6968 100644 --- a/docs/content/references/js-client/classes/internal-28.AdminPostUploadsDownloadUrlReq.md +++ b/docs/content/references/js-client/classes/internal-31.AdminPostUploadsDownloadUrlReq.md @@ -1,6 +1,6 @@ # Class: AdminPostUploadsDownloadUrlReq -[internal](../modules/internal-28.md).AdminPostUploadsDownloadUrlReq +[internal](../modules/internal-31.md).AdminPostUploadsDownloadUrlReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-28.IAdminPostUploadsFileReq.md b/docs/content/references/js-client/classes/internal-31.IAdminPostUploadsFileReq.md similarity index 82% rename from docs/content/references/js-client/classes/internal-28.IAdminPostUploadsFileReq.md rename to docs/content/references/js-client/classes/internal-31.IAdminPostUploadsFileReq.md index 997a22cac2..948262ee18 100644 --- a/docs/content/references/js-client/classes/internal-28.IAdminPostUploadsFileReq.md +++ b/docs/content/references/js-client/classes/internal-31.IAdminPostUploadsFileReq.md @@ -1,6 +1,6 @@ # Class: IAdminPostUploadsFileReq -[internal](../modules/internal-28.md).IAdminPostUploadsFileReq +[internal](../modules/internal-31.md).IAdminPostUploadsFileReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-29.AdminCreateUserRequest.md b/docs/content/references/js-client/classes/internal-32.AdminCreateUserRequest.md similarity index 92% rename from docs/content/references/js-client/classes/internal-29.AdminCreateUserRequest.md rename to docs/content/references/js-client/classes/internal-32.AdminCreateUserRequest.md index 76d27f9842..fb7243287f 100644 --- a/docs/content/references/js-client/classes/internal-29.AdminCreateUserRequest.md +++ b/docs/content/references/js-client/classes/internal-32.AdminCreateUserRequest.md @@ -1,6 +1,6 @@ # Class: AdminCreateUserRequest -[internal](../modules/internal-29.md).AdminCreateUserRequest +[internal](../modules/internal-32.md).AdminCreateUserRequest ## Properties diff --git a/docs/content/references/js-client/classes/internal-29.AdminResetPasswordRequest.md b/docs/content/references/js-client/classes/internal-32.AdminResetPasswordRequest.md similarity index 86% rename from docs/content/references/js-client/classes/internal-29.AdminResetPasswordRequest.md rename to docs/content/references/js-client/classes/internal-32.AdminResetPasswordRequest.md index 4ab9516052..876d163662 100644 --- a/docs/content/references/js-client/classes/internal-29.AdminResetPasswordRequest.md +++ b/docs/content/references/js-client/classes/internal-32.AdminResetPasswordRequest.md @@ -1,6 +1,6 @@ # Class: AdminResetPasswordRequest -[internal](../modules/internal-29.md).AdminResetPasswordRequest +[internal](../modules/internal-32.md).AdminResetPasswordRequest ## Properties diff --git a/docs/content/references/js-client/classes/internal-29.AdminResetPasswordTokenRequest.md b/docs/content/references/js-client/classes/internal-32.AdminResetPasswordTokenRequest.md similarity index 73% rename from docs/content/references/js-client/classes/internal-29.AdminResetPasswordTokenRequest.md rename to docs/content/references/js-client/classes/internal-32.AdminResetPasswordTokenRequest.md index 11c6b4b734..f7c19f95a1 100644 --- a/docs/content/references/js-client/classes/internal-29.AdminResetPasswordTokenRequest.md +++ b/docs/content/references/js-client/classes/internal-32.AdminResetPasswordTokenRequest.md @@ -1,6 +1,6 @@ # Class: AdminResetPasswordTokenRequest -[internal](../modules/internal-29.md).AdminResetPasswordTokenRequest +[internal](../modules/internal-32.md).AdminResetPasswordTokenRequest ## Properties diff --git a/docs/content/references/js-client/classes/internal-29.AdminUpdateUserRequest.md b/docs/content/references/js-client/classes/internal-32.AdminUpdateUserRequest.md similarity index 92% rename from docs/content/references/js-client/classes/internal-29.AdminUpdateUserRequest.md rename to docs/content/references/js-client/classes/internal-32.AdminUpdateUserRequest.md index a3e2b0a75a..74bfe87409 100644 --- a/docs/content/references/js-client/classes/internal-29.AdminUpdateUserRequest.md +++ b/docs/content/references/js-client/classes/internal-32.AdminUpdateUserRequest.md @@ -1,6 +1,6 @@ # Class: AdminUpdateUserRequest -[internal](../modules/internal-29.md).AdminUpdateUserRequest +[internal](../modules/internal-32.md).AdminUpdateUserRequest ## Properties diff --git a/docs/content/references/js-client/classes/internal-30.AdminGetVariantsParams.md b/docs/content/references/js-client/classes/internal-33.AdminGetVariantsParams.md similarity index 72% rename from docs/content/references/js-client/classes/internal-30.AdminGetVariantsParams.md rename to docs/content/references/js-client/classes/internal-33.AdminGetVariantsParams.md index bf3cad478a..6ebed228b8 100644 --- a/docs/content/references/js-client/classes/internal-30.AdminGetVariantsParams.md +++ b/docs/content/references/js-client/classes/internal-33.AdminGetVariantsParams.md @@ -1,10 +1,10 @@ # Class: AdminGetVariantsParams -[internal](../modules/internal-30.md).AdminGetVariantsParams +[internal](../modules/internal-33.md).AdminGetVariantsParams ## Hierarchy -- [`AdminPriceSelectionParams`](internal-30.AdminPriceSelectionParams.md) +- [`AdminPriceSelectionParams`](internal-33.AdminPriceSelectionParams.md) ↳ **`AdminGetVariantsParams`** @@ -16,7 +16,7 @@ #### Inherited from -[AdminPriceSelectionParams](internal-30.AdminPriceSelectionParams.md).[cart_id](internal-30.AdminPriceSelectionParams.md#cart_id) +[AdminPriceSelectionParams](internal-33.AdminPriceSelectionParams.md).[cart_id](internal-33.AdminPriceSelectionParams.md#cart_id) #### Defined in @@ -30,7 +30,7 @@ ___ #### Inherited from -[AdminPriceSelectionParams](internal-30.AdminPriceSelectionParams.md).[currency_code](internal-30.AdminPriceSelectionParams.md#currency_code) +[AdminPriceSelectionParams](internal-33.AdminPriceSelectionParams.md).[currency_code](internal-33.AdminPriceSelectionParams.md#currency_code) #### Defined in @@ -44,7 +44,7 @@ ___ #### Inherited from -[AdminPriceSelectionParams](internal-30.AdminPriceSelectionParams.md).[customer_id](internal-30.AdminPriceSelectionParams.md#customer_id) +[AdminPriceSelectionParams](internal-33.AdminPriceSelectionParams.md).[customer_id](internal-33.AdminPriceSelectionParams.md#customer_id) #### Defined in @@ -84,7 +84,7 @@ ___ ### inventory\_quantity -• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-27.NumericalComparisonOperator.md) +• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-30.NumericalComparisonOperator.md) #### Defined in @@ -128,7 +128,7 @@ ___ #### Inherited from -[AdminPriceSelectionParams](internal-30.AdminPriceSelectionParams.md).[region_id](internal-30.AdminPriceSelectionParams.md#region_id) +[AdminPriceSelectionParams](internal-33.AdminPriceSelectionParams.md).[region_id](internal-33.AdminPriceSelectionParams.md#region_id) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-30.AdminPriceSelectionParams.md b/docs/content/references/js-client/classes/internal-33.AdminPriceSelectionParams.md similarity index 54% rename from docs/content/references/js-client/classes/internal-30.AdminPriceSelectionParams.md rename to docs/content/references/js-client/classes/internal-33.AdminPriceSelectionParams.md index 808b9b6632..5d2755e08b 100644 --- a/docs/content/references/js-client/classes/internal-30.AdminPriceSelectionParams.md +++ b/docs/content/references/js-client/classes/internal-33.AdminPriceSelectionParams.md @@ -1,14 +1,14 @@ # Class: AdminPriceSelectionParams -[internal](../modules/internal-30.md).AdminPriceSelectionParams +[internal](../modules/internal-33.md).AdminPriceSelectionParams ## Hierarchy -- [`PriceSelectionParams`](internal-30.PriceSelectionParams.md) +- [`PriceSelectionParams`](internal-33.PriceSelectionParams.md) ↳ **`AdminPriceSelectionParams`** - ↳↳ [`AdminGetVariantsParams`](internal-30.AdminGetVariantsParams.md) + ↳↳ [`AdminGetVariantsParams`](internal-33.AdminGetVariantsParams.md) ## Properties @@ -18,7 +18,7 @@ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[cart_id](internal-30.PriceSelectionParams.md#cart_id) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[cart_id](internal-33.PriceSelectionParams.md#cart_id) #### Defined in @@ -32,7 +32,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[currency_code](internal-30.PriceSelectionParams.md#currency_code) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[currency_code](internal-33.PriceSelectionParams.md#currency_code) #### Defined in @@ -56,7 +56,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[region_id](internal-30.PriceSelectionParams.md#region_id) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[region_id](internal-33.PriceSelectionParams.md#region_id) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-30.PriceSelectionParams.md b/docs/content/references/js-client/classes/internal-33.PriceSelectionParams.md similarity index 66% rename from docs/content/references/js-client/classes/internal-30.PriceSelectionParams.md rename to docs/content/references/js-client/classes/internal-33.PriceSelectionParams.md index 0fd6ddc65b..6505a0dea1 100644 --- a/docs/content/references/js-client/classes/internal-30.PriceSelectionParams.md +++ b/docs/content/references/js-client/classes/internal-33.PriceSelectionParams.md @@ -1,16 +1,16 @@ # Class: PriceSelectionParams -[internal](../modules/internal-30.md).PriceSelectionParams +[internal](../modules/internal-33.md).PriceSelectionParams ## Hierarchy - **`PriceSelectionParams`** - ↳ [`AdminPriceSelectionParams`](internal-30.AdminPriceSelectionParams.md) + ↳ [`AdminPriceSelectionParams`](internal-33.AdminPriceSelectionParams.md) - ↳ [`StoreGetVariantsParams`](internal-41.StoreGetVariantsParams.md) + ↳ [`StoreGetVariantsParams`](internal-45.StoreGetVariantsParams.md) - ↳ [`StoreGetProductsPaginationParams`](internal-42.StoreGetProductsPaginationParams.md) + ↳ [`StoreGetProductsPaginationParams`](internal-46.StoreGetProductsPaginationParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-31.StorePostAuthReq.md b/docs/content/references/js-client/classes/internal-34.StorePostAuthReq.md similarity index 83% rename from docs/content/references/js-client/classes/internal-31.StorePostAuthReq.md rename to docs/content/references/js-client/classes/internal-34.StorePostAuthReq.md index c7aa9a1802..0bf88be06a 100644 --- a/docs/content/references/js-client/classes/internal-31.StorePostAuthReq.md +++ b/docs/content/references/js-client/classes/internal-34.StorePostAuthReq.md @@ -1,6 +1,6 @@ # Class: StorePostAuthReq -[internal](../modules/internal-31.md).StorePostAuthReq +[internal](../modules/internal-34.md).StorePostAuthReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-32.Discount.md b/docs/content/references/js-client/classes/internal-35.Discount.md similarity index 75% rename from docs/content/references/js-client/classes/internal-32.Discount.md rename to docs/content/references/js-client/classes/internal-35.Discount.md index 366299d902..fe9926f41d 100644 --- a/docs/content/references/js-client/classes/internal-32.Discount.md +++ b/docs/content/references/js-client/classes/internal-35.Discount.md @@ -1,6 +1,6 @@ # Class: Discount -[internal](../modules/internal-32.md).Discount +[internal](../modules/internal-35.md).Discount ## Properties diff --git a/docs/content/references/js-client/classes/internal-32.GiftCard.md b/docs/content/references/js-client/classes/internal-35.GiftCard.md similarity index 75% rename from docs/content/references/js-client/classes/internal-32.GiftCard.md rename to docs/content/references/js-client/classes/internal-35.GiftCard.md index c1c9619caf..e1aa298449 100644 --- a/docs/content/references/js-client/classes/internal-32.GiftCard.md +++ b/docs/content/references/js-client/classes/internal-35.GiftCard.md @@ -1,6 +1,6 @@ # Class: GiftCard -[internal](../modules/internal-32.md).GiftCard +[internal](../modules/internal-35.md).GiftCard ## Properties diff --git a/docs/content/references/js-client/classes/internal-32.Item.md b/docs/content/references/js-client/classes/internal-35.Item.md similarity index 86% rename from docs/content/references/js-client/classes/internal-32.Item.md rename to docs/content/references/js-client/classes/internal-35.Item.md index 6378136f5b..e35bfa655a 100644 --- a/docs/content/references/js-client/classes/internal-32.Item.md +++ b/docs/content/references/js-client/classes/internal-35.Item.md @@ -1,6 +1,6 @@ # Class: Item -[internal](../modules/internal-32.md).Item +[internal](../modules/internal-35.md).Item ## Properties diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCartReq.md b/docs/content/references/js-client/classes/internal-35.StorePostCartReq.md similarity index 85% rename from docs/content/references/js-client/classes/internal-32.StorePostCartReq.md rename to docs/content/references/js-client/classes/internal-35.StorePostCartReq.md index e5dd7bce13..c391a91df5 100644 --- a/docs/content/references/js-client/classes/internal-32.StorePostCartReq.md +++ b/docs/content/references/js-client/classes/internal-35.StorePostCartReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartReq -[internal](../modules/internal-32.md).StorePostCartReq +[internal](../modules/internal-35.md).StorePostCartReq ## Properties @@ -26,7 +26,7 @@ ___ ### items -• `Optional` **items**: [`Item`](internal-32.Item.md)[] +• `Optional` **items**: [`Item`](internal-35.Item.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionReq.md b/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionReq.md similarity index 75% rename from docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionReq.md rename to docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionReq.md index 92eb2db1c5..e751d9bed7 100644 --- a/docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionReq.md +++ b/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartPaymentSessionReq -[internal](../modules/internal-32.md).StorePostCartsCartPaymentSessionReq +[internal](../modules/internal-35.md).StorePostCartsCartPaymentSessionReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md b/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md similarity index 77% rename from docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md rename to docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md index 2cd6a3020f..ffb2aff6bc 100644 --- a/docs/content/references/js-client/classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md +++ b/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartPaymentSessionUpdateReq -[internal](../modules/internal-32.md).StorePostCartsCartPaymentSessionUpdateReq +[internal](../modules/internal-35.md).StorePostCartsCartPaymentSessionUpdateReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCartsCartReq.md b/docs/content/references/js-client/classes/internal-35.StorePostCartsCartReq.md similarity index 88% rename from docs/content/references/js-client/classes/internal-32.StorePostCartsCartReq.md rename to docs/content/references/js-client/classes/internal-35.StorePostCartsCartReq.md index f78c2863e7..fb21f6b3a1 100644 --- a/docs/content/references/js-client/classes/internal-32.StorePostCartsCartReq.md +++ b/docs/content/references/js-client/classes/internal-35.StorePostCartsCartReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartReq -[internal](../modules/internal-32.md).StorePostCartsCartReq +[internal](../modules/internal-35.md).StorePostCartsCartReq ## Properties @@ -46,7 +46,7 @@ ___ ### discounts -• `Optional` **discounts**: [`Discount`](internal-32.Discount.md)[] +• `Optional` **discounts**: [`Discount`](internal-35.Discount.md)[] #### Defined in @@ -66,7 +66,7 @@ ___ ### gift\_cards -• `Optional` **gift\_cards**: [`GiftCard`](internal-32.GiftCard.md)[] +• `Optional` **gift\_cards**: [`GiftCard`](internal-35.GiftCard.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCartsCartShippingMethodReq.md b/docs/content/references/js-client/classes/internal-35.StorePostCartsCartShippingMethodReq.md similarity index 84% rename from docs/content/references/js-client/classes/internal-32.StorePostCartsCartShippingMethodReq.md rename to docs/content/references/js-client/classes/internal-35.StorePostCartsCartShippingMethodReq.md index 295f76262c..4a924d4bc6 100644 --- a/docs/content/references/js-client/classes/internal-32.StorePostCartsCartShippingMethodReq.md +++ b/docs/content/references/js-client/classes/internal-35.StorePostCartsCartShippingMethodReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartShippingMethodReq -[internal](../modules/internal-32.md).StorePostCartsCartShippingMethodReq +[internal](../modules/internal-35.md).StorePostCartsCartShippingMethodReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-33.StoreGetCollectionsParams.md b/docs/content/references/js-client/classes/internal-36.StoreGetCollectionsParams.md similarity index 93% rename from docs/content/references/js-client/classes/internal-33.StoreGetCollectionsParams.md rename to docs/content/references/js-client/classes/internal-36.StoreGetCollectionsParams.md index 79739bf37b..f1ea08e013 100644 --- a/docs/content/references/js-client/classes/internal-33.StoreGetCollectionsParams.md +++ b/docs/content/references/js-client/classes/internal-36.StoreGetCollectionsParams.md @@ -1,6 +1,6 @@ # Class: StoreGetCollectionsParams -[internal](../modules/internal-33.md).StoreGetCollectionsParams +[internal](../modules/internal-36.md).StoreGetCollectionsParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md b/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md similarity index 84% rename from docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md rename to docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md index 08a5cac49d..aa020f3a9f 100644 --- a/docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md @@ -1,12 +1,12 @@ # Class: StoreGetCustomersCustomerOrdersPaginationParams -[internal](../modules/internal-34.md).StoreGetCustomersCustomerOrdersPaginationParams +[internal](../modules/internal-37.md).StoreGetCustomersCustomerOrdersPaginationParams ## Hierarchy - **`StoreGetCustomersCustomerOrdersPaginationParams`** - ↳ [`StoreGetCustomersCustomerOrdersParams`](internal-34.StoreGetCustomersCustomerOrdersParams.md) + ↳ [`StoreGetCustomersCustomerOrdersParams`](internal-37.StoreGetCustomersCustomerOrdersParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersParams.md b/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersParams.md similarity index 84% rename from docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersParams.md rename to docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersParams.md index 8b915951b9..3dfbca09ea 100644 --- a/docs/content/references/js-client/classes/internal-34.StoreGetCustomersCustomerOrdersParams.md +++ b/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersParams.md @@ -1,10 +1,10 @@ # Class: StoreGetCustomersCustomerOrdersParams -[internal](../modules/internal-34.md).StoreGetCustomersCustomerOrdersParams +[internal](../modules/internal-37.md).StoreGetCustomersCustomerOrdersParams ## Hierarchy -- [`StoreGetCustomersCustomerOrdersPaginationParams`](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md) +- [`StoreGetCustomersCustomerOrdersPaginationParams`](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md) ↳ **`StoreGetCustomersCustomerOrdersParams`** @@ -76,7 +76,7 @@ ___ #### Inherited from -[StoreGetCustomersCustomerOrdersPaginationParams](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md).[expand](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md#expand) +[StoreGetCustomersCustomerOrdersPaginationParams](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md).[expand](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md#expand) #### Defined in @@ -90,7 +90,7 @@ ___ #### Inherited from -[StoreGetCustomersCustomerOrdersPaginationParams](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md).[fields](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md#fields) +[StoreGetCustomersCustomerOrdersPaginationParams](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md).[fields](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md#fields) #### Defined in @@ -124,7 +124,7 @@ ___ #### Inherited from -[StoreGetCustomersCustomerOrdersPaginationParams](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md).[limit](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md#limit) +[StoreGetCustomersCustomerOrdersPaginationParams](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md).[limit](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md#limit) #### Defined in @@ -138,7 +138,7 @@ ___ #### Inherited from -[StoreGetCustomersCustomerOrdersPaginationParams](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md).[offset](internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md#offset) +[StoreGetCustomersCustomerOrdersPaginationParams](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md).[offset](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md#offset) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md b/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md similarity index 76% rename from docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md rename to docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md index 91589cb218..4492dc8979 100644 --- a/docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md +++ b/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md @@ -1,6 +1,6 @@ # Class: StorePostCustomersCustomerPasswordTokenReq -[internal](../modules/internal-34.md).StorePostCustomersCustomerPasswordTokenReq +[internal](../modules/internal-37.md).StorePostCustomersCustomerPasswordTokenReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerReq.md similarity index 94% rename from docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerReq.md rename to docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerReq.md index 6a0cb66d1a..13ce63dd24 100644 --- a/docs/content/references/js-client/classes/internal-34.StorePostCustomersCustomerReq.md +++ b/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerReq.md @@ -1,6 +1,6 @@ # Class: StorePostCustomersCustomerReq -[internal](../modules/internal-34.md).StorePostCustomersCustomerReq +[internal](../modules/internal-37.md).StorePostCustomersCustomerReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCustomersReq.md b/docs/content/references/js-client/classes/internal-37.StorePostCustomersReq.md similarity index 92% rename from docs/content/references/js-client/classes/internal-34.StorePostCustomersReq.md rename to docs/content/references/js-client/classes/internal-37.StorePostCustomersReq.md index 0fee638fc9..52492a18bd 100644 --- a/docs/content/references/js-client/classes/internal-34.StorePostCustomersReq.md +++ b/docs/content/references/js-client/classes/internal-37.StorePostCustomersReq.md @@ -1,6 +1,6 @@ # Class: StorePostCustomersReq -[internal](../modules/internal-34.md).StorePostCustomersReq +[internal](../modules/internal-37.md).StorePostCustomersReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCustomersResetPasswordReq.md b/docs/content/references/js-client/classes/internal-37.StorePostCustomersResetPasswordReq.md similarity index 87% rename from docs/content/references/js-client/classes/internal-34.StorePostCustomersResetPasswordReq.md rename to docs/content/references/js-client/classes/internal-37.StorePostCustomersResetPasswordReq.md index a1243a1d86..e59965d0c0 100644 --- a/docs/content/references/js-client/classes/internal-34.StorePostCustomersResetPasswordReq.md +++ b/docs/content/references/js-client/classes/internal-37.StorePostCustomersResetPasswordReq.md @@ -1,6 +1,6 @@ # Class: StorePostCustomersResetPasswordReq -[internal](../modules/internal-34.md).StorePostCustomersResetPasswordReq +[internal](../modules/internal-37.md).StorePostCustomersResetPasswordReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsItemReq.md b/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsItemReq.md similarity index 74% rename from docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsItemReq.md rename to docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsItemReq.md index b6b4b2e2e2..aa96ed67c3 100644 --- a/docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsItemReq.md +++ b/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsItemReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartLineItemsItemReq -[internal](../modules/internal-36.md).StorePostCartsCartLineItemsItemReq +[internal](../modules/internal-39.md).StorePostCartsCartLineItemsItemReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsReq.md b/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsReq.md similarity index 52% rename from docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsReq.md rename to docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsReq.md index 0c076c9e80..39a0999f75 100644 --- a/docs/content/references/js-client/classes/internal-36.StorePostCartsCartLineItemsReq.md +++ b/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsReq.md @@ -1,6 +1,6 @@ # Class: StorePostCartsCartLineItemsReq -[internal](../modules/internal-36.md).StorePostCartsCartLineItemsReq +[internal](../modules/internal-39.md).StorePostCartsCartLineItemsReq ## Properties @@ -10,7 +10,7 @@ #### Defined in -medusa/dist/api/routes/store/carts/create-line-item.d.ts:61 +medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:61 ___ @@ -20,7 +20,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/create-line-item.d.ts:60 +medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:60 ___ @@ -30,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/carts/create-line-item.d.ts:59 +medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:59 diff --git a/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md b/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md index 0f0df547b7..c088e919be 100644 --- a/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md @@ -8,9 +8,9 @@ ↳ [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) - ↳ [`AdminGetProductTypesParams`](internal-17.AdminGetProductTypesParams.md) + ↳ [`AdminGetProductTypesParams`](internal-19.AdminGetProductTypesParams.md) - ↳ [`StoreGetProductTypesParams`](internal-40.StoreGetProductTypesParams.md) + ↳ [`StoreGetProductTypesParams`](internal-44.StoreGetProductTypesParams.md) ## Properties diff --git a/docs/content/references/js-client/classes/internal-37.StorePostOrderEditsOrderEditDecline.md b/docs/content/references/js-client/classes/internal-40.StorePostOrderEditsOrderEditDecline.md similarity index 77% rename from docs/content/references/js-client/classes/internal-37.StorePostOrderEditsOrderEditDecline.md rename to docs/content/references/js-client/classes/internal-40.StorePostOrderEditsOrderEditDecline.md index 2191c50298..3c1c1e9e1b 100644 --- a/docs/content/references/js-client/classes/internal-37.StorePostOrderEditsOrderEditDecline.md +++ b/docs/content/references/js-client/classes/internal-40.StorePostOrderEditsOrderEditDecline.md @@ -1,6 +1,6 @@ # Class: StorePostOrderEditsOrderEditDecline -[internal](../modules/internal-37.md).StorePostOrderEditsOrderEditDecline +[internal](../modules/internal-40.md).StorePostOrderEditsOrderEditDecline ## Properties diff --git a/docs/content/references/js-client/classes/internal-38.ShippingAddressPayload.md b/docs/content/references/js-client/classes/internal-41.ShippingAddressPayload.md similarity index 75% rename from docs/content/references/js-client/classes/internal-38.ShippingAddressPayload.md rename to docs/content/references/js-client/classes/internal-41.ShippingAddressPayload.md index 455269096d..b4fba12f93 100644 --- a/docs/content/references/js-client/classes/internal-38.ShippingAddressPayload.md +++ b/docs/content/references/js-client/classes/internal-41.ShippingAddressPayload.md @@ -1,6 +1,6 @@ # Class: ShippingAddressPayload -[internal](../modules/internal-38.md).ShippingAddressPayload +[internal](../modules/internal-41.md).ShippingAddressPayload ## Properties diff --git a/docs/content/references/js-client/classes/internal-38.StoreGetOrdersParams.md b/docs/content/references/js-client/classes/internal-41.StoreGetOrdersParams.md similarity index 82% rename from docs/content/references/js-client/classes/internal-38.StoreGetOrdersParams.md rename to docs/content/references/js-client/classes/internal-41.StoreGetOrdersParams.md index ff758051dc..128a6c5d93 100644 --- a/docs/content/references/js-client/classes/internal-38.StoreGetOrdersParams.md +++ b/docs/content/references/js-client/classes/internal-41.StoreGetOrdersParams.md @@ -1,6 +1,6 @@ # Class: StoreGetOrdersParams -[internal](../modules/internal-38.md).StoreGetOrdersParams +[internal](../modules/internal-41.md).StoreGetOrdersParams ## Properties @@ -26,7 +26,7 @@ ___ ### shipping\_address -• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal-38.ShippingAddressPayload.md) +• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal-41.ShippingAddressPayload.md) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-42.PaymentCollectionSessionInputRequest.md b/docs/content/references/js-client/classes/internal-42.PaymentCollectionSessionInputRequest.md new file mode 100644 index 0000000000..0f2183dbd5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-42.PaymentCollectionSessionInputRequest.md @@ -0,0 +1,43 @@ +# Class: PaymentCollectionSessionInputRequest + +[internal](../modules/internal-42.md).PaymentCollectionSessionInputRequest + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +medusa/dist/api/routes/store/payment-collections/manage-payment-sessions.d.ts:109 + +___ + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/payment-collections/manage-payment-sessions.d.ts:108 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/payment-collections/manage-payment-sessions.d.ts:107 + +___ + +### session\_id + +• `Optional` **session\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/payment-collections/manage-payment-sessions.d.ts:110 diff --git a/docs/content/references/js-client/classes/internal-42.StoreManagePaymentCollectionSessionRequest.md b/docs/content/references/js-client/classes/internal-42.StoreManagePaymentCollectionSessionRequest.md new file mode 100644 index 0000000000..082b55f58f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-42.StoreManagePaymentCollectionSessionRequest.md @@ -0,0 +1,13 @@ +# Class: StoreManagePaymentCollectionSessionRequest + +[internal](../modules/internal-42.md).StoreManagePaymentCollectionSessionRequest + +## Properties + +### sessions + +• **sessions**: [`PaymentCollectionSessionInputRequest`](internal-42.PaymentCollectionSessionInputRequest.md) \| [`PaymentCollectionSessionInputRequest`](internal-42.PaymentCollectionSessionInputRequest.md)[] + +#### Defined in + +medusa/dist/api/routes/store/payment-collections/manage-payment-sessions.d.ts:113 diff --git a/docs/content/references/js-client/classes/internal-42.StoreRefreshPaymentCollectionSessionRequest.md b/docs/content/references/js-client/classes/internal-42.StoreRefreshPaymentCollectionSessionRequest.md new file mode 100644 index 0000000000..84fc48f4c1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-42.StoreRefreshPaymentCollectionSessionRequest.md @@ -0,0 +1,23 @@ +# Class: StoreRefreshPaymentCollectionSessionRequest + +[internal](../modules/internal-42.md).StoreRefreshPaymentCollectionSessionRequest + +## Properties + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/payment-collections/refresh-payment-session.d.ts:63 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/payment-collections/refresh-payment-session.d.ts:62 diff --git a/docs/content/references/js-client/classes/internal-40.StoreGetProductTypesParams.md b/docs/content/references/js-client/classes/internal-44.StoreGetProductTypesParams.md similarity index 96% rename from docs/content/references/js-client/classes/internal-40.StoreGetProductTypesParams.md rename to docs/content/references/js-client/classes/internal-44.StoreGetProductTypesParams.md index 215e4fb664..134ad7197c 100644 --- a/docs/content/references/js-client/classes/internal-40.StoreGetProductTypesParams.md +++ b/docs/content/references/js-client/classes/internal-44.StoreGetProductTypesParams.md @@ -1,6 +1,6 @@ # Class: StoreGetProductTypesParams -[internal](../modules/internal-40.md).StoreGetProductTypesParams +[internal](../modules/internal-44.md).StoreGetProductTypesParams ## Hierarchy diff --git a/docs/content/references/js-client/classes/internal-41.StoreGetVariantsParams.md b/docs/content/references/js-client/classes/internal-45.StoreGetVariantsParams.md similarity index 73% rename from docs/content/references/js-client/classes/internal-41.StoreGetVariantsParams.md rename to docs/content/references/js-client/classes/internal-45.StoreGetVariantsParams.md index db071387c5..97797ab3b5 100644 --- a/docs/content/references/js-client/classes/internal-41.StoreGetVariantsParams.md +++ b/docs/content/references/js-client/classes/internal-45.StoreGetVariantsParams.md @@ -1,10 +1,10 @@ # Class: StoreGetVariantsParams -[internal](../modules/internal-41.md).StoreGetVariantsParams +[internal](../modules/internal-45.md).StoreGetVariantsParams ## Hierarchy -- [`PriceSelectionParams`](internal-30.PriceSelectionParams.md) +- [`PriceSelectionParams`](internal-33.PriceSelectionParams.md) ↳ **`StoreGetVariantsParams`** @@ -16,7 +16,7 @@ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[cart_id](internal-30.PriceSelectionParams.md#cart_id) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[cart_id](internal-33.PriceSelectionParams.md#cart_id) #### Defined in @@ -30,7 +30,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[currency_code](internal-30.PriceSelectionParams.md#currency_code) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[currency_code](internal-33.PriceSelectionParams.md#currency_code) #### Defined in @@ -70,7 +70,7 @@ ___ ### inventory\_quantity -• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-27.NumericalComparisonOperator.md) +• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-30.NumericalComparisonOperator.md) #### Defined in @@ -104,7 +104,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[region_id](internal-30.PriceSelectionParams.md#region_id) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[region_id](internal-33.PriceSelectionParams.md#region_id) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-42.StoreGetProductsPaginationParams.md b/docs/content/references/js-client/classes/internal-46.StoreGetProductsPaginationParams.md similarity index 66% rename from docs/content/references/js-client/classes/internal-42.StoreGetProductsPaginationParams.md rename to docs/content/references/js-client/classes/internal-46.StoreGetProductsPaginationParams.md index 903176d554..e8077b97cf 100644 --- a/docs/content/references/js-client/classes/internal-42.StoreGetProductsPaginationParams.md +++ b/docs/content/references/js-client/classes/internal-46.StoreGetProductsPaginationParams.md @@ -1,14 +1,14 @@ # Class: StoreGetProductsPaginationParams -[internal](../modules/internal-42.md).StoreGetProductsPaginationParams +[internal](../modules/internal-46.md).StoreGetProductsPaginationParams ## Hierarchy -- [`PriceSelectionParams`](internal-30.PriceSelectionParams.md) +- [`PriceSelectionParams`](internal-33.PriceSelectionParams.md) ↳ **`StoreGetProductsPaginationParams`** - ↳↳ [`StoreGetProductsParams`](internal-42.StoreGetProductsParams.md) + ↳↳ [`StoreGetProductsParams`](internal-46.StoreGetProductsParams.md) ## Properties @@ -18,7 +18,7 @@ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[cart_id](internal-30.PriceSelectionParams.md#cart_id) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[cart_id](internal-33.PriceSelectionParams.md#cart_id) #### Defined in @@ -32,7 +32,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[currency_code](internal-30.PriceSelectionParams.md#currency_code) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[currency_code](internal-33.PriceSelectionParams.md#currency_code) #### Defined in @@ -86,7 +86,7 @@ ___ #### Inherited from -[PriceSelectionParams](internal-30.PriceSelectionParams.md).[region_id](internal-30.PriceSelectionParams.md#region_id) +[PriceSelectionParams](internal-33.PriceSelectionParams.md).[region_id](internal-33.PriceSelectionParams.md#region_id) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-42.StoreGetProductsParams.md b/docs/content/references/js-client/classes/internal-46.StoreGetProductsParams.md similarity index 75% rename from docs/content/references/js-client/classes/internal-42.StoreGetProductsParams.md rename to docs/content/references/js-client/classes/internal-46.StoreGetProductsParams.md index ec7da2758e..45e36b49ea 100644 --- a/docs/content/references/js-client/classes/internal-42.StoreGetProductsParams.md +++ b/docs/content/references/js-client/classes/internal-46.StoreGetProductsParams.md @@ -1,10 +1,10 @@ # Class: StoreGetProductsParams -[internal](../modules/internal-42.md).StoreGetProductsParams +[internal](../modules/internal-46.md).StoreGetProductsParams ## Hierarchy -- [`StoreGetProductsPaginationParams`](internal-42.StoreGetProductsPaginationParams.md) +- [`StoreGetProductsPaginationParams`](internal-46.StoreGetProductsPaginationParams.md) ↳ **`StoreGetProductsParams`** @@ -16,7 +16,7 @@ #### Inherited from -[StoreGetProductsPaginationParams](internal-42.StoreGetProductsPaginationParams.md).[cart_id](internal-42.StoreGetProductsPaginationParams.md#cart_id) +[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[cart_id](internal-46.StoreGetProductsPaginationParams.md#cart_id) #### Defined in @@ -50,7 +50,7 @@ ___ #### Inherited from -[StoreGetProductsPaginationParams](internal-42.StoreGetProductsPaginationParams.md).[currency_code](internal-42.StoreGetProductsPaginationParams.md#currency_code) +[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[currency_code](internal-46.StoreGetProductsPaginationParams.md#currency_code) #### Defined in @@ -74,7 +74,7 @@ ___ #### Inherited from -[StoreGetProductsPaginationParams](internal-42.StoreGetProductsPaginationParams.md).[expand](internal-42.StoreGetProductsPaginationParams.md#expand) +[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[expand](internal-46.StoreGetProductsPaginationParams.md#expand) #### Defined in @@ -88,7 +88,7 @@ ___ #### Inherited from -[StoreGetProductsPaginationParams](internal-42.StoreGetProductsPaginationParams.md).[fields](internal-42.StoreGetProductsPaginationParams.md#fields) +[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[fields](internal-46.StoreGetProductsPaginationParams.md#fields) #### Defined in @@ -132,7 +132,7 @@ ___ #### Inherited from -[StoreGetProductsPaginationParams](internal-42.StoreGetProductsPaginationParams.md).[limit](internal-42.StoreGetProductsPaginationParams.md#limit) +[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[limit](internal-46.StoreGetProductsPaginationParams.md#limit) #### Defined in @@ -146,7 +146,7 @@ ___ #### Inherited from -[StoreGetProductsPaginationParams](internal-42.StoreGetProductsPaginationParams.md).[offset](internal-42.StoreGetProductsPaginationParams.md#offset) +[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[offset](internal-46.StoreGetProductsPaginationParams.md#offset) #### Defined in @@ -170,7 +170,7 @@ ___ #### Inherited from -[StoreGetProductsPaginationParams](internal-42.StoreGetProductsPaginationParams.md).[region_id](internal-42.StoreGetProductsPaginationParams.md#region_id) +[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[region_id](internal-46.StoreGetProductsPaginationParams.md#region_id) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-42.StorePostSearchReq.md b/docs/content/references/js-client/classes/internal-46.StorePostSearchReq.md similarity index 90% rename from docs/content/references/js-client/classes/internal-42.StorePostSearchReq.md rename to docs/content/references/js-client/classes/internal-46.StorePostSearchReq.md index f02608e057..a31b99d1df 100644 --- a/docs/content/references/js-client/classes/internal-42.StorePostSearchReq.md +++ b/docs/content/references/js-client/classes/internal-46.StorePostSearchReq.md @@ -1,6 +1,6 @@ # Class: StorePostSearchReq -[internal](../modules/internal-42.md).StorePostSearchReq +[internal](../modules/internal-46.md).StorePostSearchReq ## Properties diff --git a/docs/content/references/js-client/classes/internal-45.Item.md b/docs/content/references/js-client/classes/internal-49.Item.md similarity index 92% rename from docs/content/references/js-client/classes/internal-45.Item.md rename to docs/content/references/js-client/classes/internal-49.Item.md index 2588ac3cb5..40b18d8cfa 100644 --- a/docs/content/references/js-client/classes/internal-45.Item.md +++ b/docs/content/references/js-client/classes/internal-49.Item.md @@ -1,6 +1,6 @@ # Class: Item -[internal](../modules/internal-45.md).Item +[internal](../modules/internal-49.md).Item ## Properties diff --git a/docs/content/references/js-client/classes/internal-45.ReturnShipping.md b/docs/content/references/js-client/classes/internal-49.ReturnShipping.md similarity index 75% rename from docs/content/references/js-client/classes/internal-45.ReturnShipping.md rename to docs/content/references/js-client/classes/internal-49.ReturnShipping.md index 6615c8544e..01154c9ef3 100644 --- a/docs/content/references/js-client/classes/internal-45.ReturnShipping.md +++ b/docs/content/references/js-client/classes/internal-49.ReturnShipping.md @@ -1,6 +1,6 @@ # Class: ReturnShipping -[internal](../modules/internal-45.md).ReturnShipping +[internal](../modules/internal-49.md).ReturnShipping ## Properties diff --git a/docs/content/references/js-client/classes/internal-45.StorePostReturnsReq.md b/docs/content/references/js-client/classes/internal-49.StorePostReturnsReq.md similarity index 77% rename from docs/content/references/js-client/classes/internal-45.StorePostReturnsReq.md rename to docs/content/references/js-client/classes/internal-49.StorePostReturnsReq.md index adbaec2880..c4bd4557d1 100644 --- a/docs/content/references/js-client/classes/internal-45.StorePostReturnsReq.md +++ b/docs/content/references/js-client/classes/internal-49.StorePostReturnsReq.md @@ -1,12 +1,12 @@ # Class: StorePostReturnsReq -[internal](../modules/internal-45.md).StorePostReturnsReq +[internal](../modules/internal-49.md).StorePostReturnsReq ## Properties ### items -• **items**: [`Item`](internal-45.Item.md)[] +• **items**: [`Item`](internal-49.Item.md)[] #### Defined in @@ -26,7 +26,7 @@ ___ ### return\_shipping -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-45.ReturnShipping.md) +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-49.ReturnShipping.md) #### Defined in diff --git a/docs/content/references/js-client/classes/internal-5.FindParams.md b/docs/content/references/js-client/classes/internal-5.FindParams.md index 4a169ffcf2..302af1e8f4 100644 --- a/docs/content/references/js-client/classes/internal-5.FindParams.md +++ b/docs/content/references/js-client/classes/internal-5.FindParams.md @@ -18,6 +18,10 @@ ↳ [`GetOrderEditsOrderEditParams`](internal-13.GetOrderEditsOrderEditParams.md) + ↳ [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) + + ↳ [`GetPaymentsParams`](internal-16.GetPaymentsParams.md) + ## Properties ### expand diff --git a/docs/content/references/js-client/classes/internal-46.StoreGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-50.StoreGetShippingOptionsParams.md similarity index 88% rename from docs/content/references/js-client/classes/internal-46.StoreGetShippingOptionsParams.md rename to docs/content/references/js-client/classes/internal-50.StoreGetShippingOptionsParams.md index ea557db932..43fa3b4227 100644 --- a/docs/content/references/js-client/classes/internal-46.StoreGetShippingOptionsParams.md +++ b/docs/content/references/js-client/classes/internal-50.StoreGetShippingOptionsParams.md @@ -1,6 +1,6 @@ # Class: StoreGetShippingOptionsParams -[internal](../modules/internal-46.md).StoreGetShippingOptionsParams +[internal](../modules/internal-50.md).StoreGetShippingOptionsParams ## Properties diff --git a/docs/content/references/js-client/classes/internal-47.AdditionalItem.md b/docs/content/references/js-client/classes/internal-51.AdditionalItem.md similarity index 84% rename from docs/content/references/js-client/classes/internal-47.AdditionalItem.md rename to docs/content/references/js-client/classes/internal-51.AdditionalItem.md index c6ddfdc688..0095524ba4 100644 --- a/docs/content/references/js-client/classes/internal-47.AdditionalItem.md +++ b/docs/content/references/js-client/classes/internal-51.AdditionalItem.md @@ -1,6 +1,6 @@ # Class: AdditionalItem -[internal](../modules/internal-47.md).AdditionalItem +[internal](../modules/internal-51.md).AdditionalItem ## Properties diff --git a/docs/content/references/js-client/classes/internal-47.Item.md b/docs/content/references/js-client/classes/internal-51.Item.md similarity index 92% rename from docs/content/references/js-client/classes/internal-47.Item.md rename to docs/content/references/js-client/classes/internal-51.Item.md index 94de5b148b..5e7bf71e43 100644 --- a/docs/content/references/js-client/classes/internal-47.Item.md +++ b/docs/content/references/js-client/classes/internal-51.Item.md @@ -1,6 +1,6 @@ # Class: Item -[internal](../modules/internal-47.md).Item +[internal](../modules/internal-51.md).Item ## Properties diff --git a/docs/content/references/js-client/classes/internal-47.StorePostSwapsReq.md b/docs/content/references/js-client/classes/internal-51.StorePostSwapsReq.md similarity index 75% rename from docs/content/references/js-client/classes/internal-47.StorePostSwapsReq.md rename to docs/content/references/js-client/classes/internal-51.StorePostSwapsReq.md index 40a821e6cc..f65c581f36 100644 --- a/docs/content/references/js-client/classes/internal-47.StorePostSwapsReq.md +++ b/docs/content/references/js-client/classes/internal-51.StorePostSwapsReq.md @@ -1,12 +1,12 @@ # Class: StorePostSwapsReq -[internal](../modules/internal-47.md).StorePostSwapsReq +[internal](../modules/internal-51.md).StorePostSwapsReq ## Properties ### additional\_items -• **additional\_items**: [`AdditionalItem`](internal-47.AdditionalItem.md)[] +• **additional\_items**: [`AdditionalItem`](internal-51.AdditionalItem.md)[] #### Defined in @@ -26,7 +26,7 @@ ___ ### return\_items -• **return\_items**: [`Item`](internal-47.Item.md)[] +• **return\_items**: [`Item`](internal-51.Item.md)[] #### Defined in diff --git a/docs/content/references/js-client/classes/internal.BaseEntity.md b/docs/content/references/js-client/classes/internal.BaseEntity.md index 5fb341861b..c08508be91 100644 --- a/docs/content/references/js-client/classes/internal.BaseEntity.md +++ b/docs/content/references/js-client/classes/internal.BaseEntity.md @@ -38,7 +38,9 @@ Base abstract entity for all entities ↳ [`Notification`](internal-12.Notification.md) - ↳ [`Store`](internal-25.Store.md) + ↳ [`PublishableApiKey`](internal-21.PublishableApiKey.md) + + ↳ [`Store`](internal-28.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 09d4b8c969..317e5135bf 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/a4dd26e13/packages/medusa-js/src/request.ts#L29) +[medusa-js/src/request.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L34) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:30](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L30) +[medusa-js/src/request.ts:35](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L35) ## Methods @@ -48,7 +48,7 @@ and the exponential backoff approach. #### Defined in -[medusa-js/src/request.ts:146](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L146) +[medusa-js/src/request.ts:158](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L158) ___ @@ -68,7 +68,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:83](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L83) +[medusa-js/src/request.ts:88](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L88) ___ @@ -88,7 +88,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:71](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L71) +[medusa-js/src/request.ts:76](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L76) ___ @@ -114,7 +114,7 @@ Axios request #### Defined in -[medusa-js/src/request.ts:183](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L183) +[medusa-js/src/request.ts:195](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L195) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:92](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L92) +[medusa-js/src/request.ts:97](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L97) ___ @@ -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/a4dd26e13/packages/medusa-js/src/request.ts#L108) +[medusa-js/src/request.ts:113](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L113) ___ @@ -183,4 +183,4 @@ ___ #### Defined in -[medusa-js/src/request.ts:40](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L40) +[medusa-js/src/request.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L45) diff --git a/docs/content/references/js-client/classes/internal.PaymentCollection.md b/docs/content/references/js-client/classes/internal.PaymentCollection.md index 36f979e7c8..3f7d9e7144 100644 --- a/docs/content/references/js-client/classes/internal.PaymentCollection.md +++ b/docs/content/references/js-client/classes/internal.PaymentCollection.md @@ -22,17 +22,17 @@ Base abstract entity for all entities #### Defined in -medusa/dist/models/payment-collection.d.ts:22 +medusa/dist/models/payment-collection.d.ts:17 ___ ### authorized\_amount -• **authorized\_amount**: `number` +• **authorized\_amount**: ``null`` \| `number` #### Defined in -medusa/dist/models/payment-collection.d.ts:23 +medusa/dist/models/payment-collection.d.ts:18 ___ @@ -42,17 +42,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:34 - -___ - -### captured\_amount - -• **captured\_amount**: `number` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:24 +medusa/dist/models/payment-collection.d.ts:27 ___ @@ -76,7 +66,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:33 +medusa/dist/models/payment-collection.d.ts:26 ___ @@ -86,7 +76,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:29 +medusa/dist/models/payment-collection.d.ts:22 ___ @@ -96,7 +86,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:28 +medusa/dist/models/payment-collection.d.ts:21 ___ @@ -116,11 +106,11 @@ ___ ### description -• **description**: `string` +• **description**: ``null`` \| `string` #### Defined in -medusa/dist/models/payment-collection.d.ts:21 +medusa/dist/models/payment-collection.d.ts:16 ___ @@ -144,7 +134,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:32 +medusa/dist/models/payment-collection.d.ts:25 ___ @@ -154,7 +144,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:30 +medusa/dist/models/payment-collection.d.ts:23 ___ @@ -164,17 +154,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:31 - -___ - -### refunded\_amount - -• **refunded\_amount**: `number` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:25 +medusa/dist/models/payment-collection.d.ts:24 ___ @@ -184,7 +164,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:27 +medusa/dist/models/payment-collection.d.ts:20 ___ @@ -194,7 +174,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:26 +medusa/dist/models/payment-collection.d.ts:19 ___ @@ -204,7 +184,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:20 +medusa/dist/models/payment-collection.d.ts:15 ___ @@ -214,7 +194,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:19 +medusa/dist/models/payment-collection.d.ts:14 ___ diff --git a/docs/content/references/js-client/enums/internal-16.RefundReason.md b/docs/content/references/js-client/enums/internal-16.RefundReason.md new file mode 100644 index 0000000000..7b2e3053c1 --- /dev/null +++ b/docs/content/references/js-client/enums/internal-16.RefundReason.md @@ -0,0 +1,53 @@ +# Enumeration: RefundReason + +[internal](../modules/internal-16.md).RefundReason + +## Enumeration Members + +### CLAIM + +• **CLAIM** = ``"claim"`` + +#### Defined in + +medusa/dist/models/refund.d.ts:8 + +___ + +### DISCOUNT + +• **DISCOUNT** = ``"discount"`` + +#### Defined in + +medusa/dist/models/refund.d.ts:5 + +___ + +### OTHER + +• **OTHER** = ``"other"`` + +#### Defined in + +medusa/dist/models/refund.d.ts:9 + +___ + +### RETURN + +• **RETURN** = ``"return"`` + +#### Defined in + +medusa/dist/models/refund.d.ts:6 + +___ + +### SWAP + +• **SWAP** = ``"swap"`` + +#### Defined in + +medusa/dist/models/refund.d.ts:7 diff --git a/docs/content/references/js-client/enums/internal.PaymentCollectionStatus.md b/docs/content/references/js-client/enums/internal.PaymentCollectionStatus.md index 9d9dfc2e48..0a2fa20d1c 100644 --- a/docs/content/references/js-client/enums/internal.PaymentCollectionStatus.md +++ b/docs/content/references/js-client/enums/internal.PaymentCollectionStatus.md @@ -34,16 +34,6 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:12 - -___ - -### CAPTURED - -• **CAPTURED** = ``"captured"`` - -#### Defined in - medusa/dist/models/payment-collection.d.ts:8 ___ @@ -65,43 +55,3 @@ ___ #### Defined in medusa/dist/models/payment-collection.d.ts:7 - -___ - -### PARTIALLY\_CAPTURED - -• **PARTIALLY\_CAPTURED** = ``"partially_captured"`` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:9 - -___ - -### PARTIALLY\_REFUNDED - -• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:11 - -___ - -### REFUNDED - -• **REFUNDED** = ``"refunded"`` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:10 - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:13 diff --git a/docs/content/references/js-client/index.md b/docs/content/references/js-client/index.md index a4bf99d105..4e1a6d6a5b 100644 --- a/docs/content/references/js-client/index.md +++ b/docs/content/references/js-client/index.md @@ -50,6 +50,10 @@ - [internal](modules/internal-45.md) - [internal](modules/internal-46.md) - [internal](modules/internal-47.md) +- [internal](modules/internal-48.md) +- [internal](modules/internal-49.md) +- [internal](modules/internal-50.md) +- [internal](modules/internal-51.md) ## Classes @@ -69,10 +73,13 @@ - [AdminNotificationsResource](classes/AdminNotificationsResource.md) - [AdminOrderEditsResource](classes/AdminOrderEditsResource.md) - [AdminOrdersResource](classes/AdminOrdersResource.md) +- [AdminPaymentCollectionsResource](classes/AdminPaymentCollectionsResource.md) +- [AdminPaymentsResource](classes/AdminPaymentsResource.md) - [AdminPriceListResource](classes/AdminPriceListResource.md) - [AdminProductTagsResource](classes/AdminProductTagsResource.md) - [AdminProductTypesResource](classes/AdminProductTypesResource.md) - [AdminProductsResource](classes/AdminProductsResource.md) +- [AdminPublishableApiKeyResource](classes/AdminPublishableApiKeyResource.md) - [AdminRegionsResource](classes/AdminRegionsResource.md) - [AdminReturnReasonsResource](classes/AdminReturnReasonsResource.md) - [AdminReturnsResource](classes/AdminReturnsResource.md) @@ -93,6 +100,7 @@ - [LineItemsResource](classes/LineItemsResource.md) - [OrderEditsResource](classes/OrderEditsResource.md) - [OrdersResource](classes/OrdersResource.md) +- [PaymentCollectionsResource](classes/PaymentCollectionsResource.md) - [PaymentMethodsResource](classes/PaymentMethodsResource.md) - [ProductTypesResource](classes/ProductTypesResource.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 9ffe99cbd5..6bb158ba28 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/a4dd26e13/packages/medusa-js/src/request.ts#L14) +[medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L17) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:12](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L12) +[medusa-js/src/request.ts:15](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L15) ___ @@ -34,4 +34,14 @@ ___ #### Defined in -[medusa-js/src/request.ts:13](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L13) +[medusa-js/src/request.ts:16](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L16) + +___ + +### publishableApiKey + +• `Optional` **publishableApiKey**: `string` + +#### Defined in + +[medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L18) diff --git a/docs/content/references/js-client/interfaces/internal.HTTPResponse.md b/docs/content/references/js-client/interfaces/internal.HTTPResponse.md index 5efdf5ea5b..4c820a43bc 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/a4dd26e13/packages/medusa-js/src/typings.ts#L13) +[medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/typings.ts#L10) +[medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/typings.ts#L14) +[medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/typings.ts#L8) +[medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/105c68929/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/a4dd26e13/packages/medusa-js/src/typings.ts#L9) +[medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/105c68929/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 184e586a68..5dcefa3d06 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/a4dd26e13/packages/medusa-js/src/request.ts#L18) +[medusa-js/src/request.ts:23](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L23) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L17) +[medusa-js/src/request.ts:22](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L22) diff --git a/docs/content/references/js-client/modules/internal-10.md b/docs/content/references/js-client/modules/internal-10.md index f9495d159f..085f903121 100644 --- a/docs/content/references/js-client/modules/internal-10.md +++ b/docs/content/references/js-client/modules/internal-10.md @@ -31,7 +31,7 @@ ___ #### Defined in -[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L47) +[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L47) ___ @@ -41,4 +41,4 @@ ___ #### Defined in -[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L45) +[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L45) diff --git a/docs/content/references/js-client/modules/internal-15.md b/docs/content/references/js-client/modules/internal-15.md index ffd00667af..d73372d4ce 100644 --- a/docs/content/references/js-client/modules/internal-15.md +++ b/docs/content/references/js-client/modules/internal-15.md @@ -2,68 +2,39 @@ ## Classes -- [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) +- [AdminUpdatePaymentCollectionRequest](../classes/internal-15.AdminUpdatePaymentCollectionRequest.md) +- [GetPaymentCollectionsParams](../classes/internal-15.GetPaymentCollectionsParams.md) ## Type Aliases -### AdminPriceListDeleteBatchRes +### AdminPaymentCollectionDeleteRes -Ƭ **AdminPriceListDeleteBatchRes**: `Object` +Ƭ **AdminPaymentCollectionDeleteRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | | `deleted` | `boolean` | -| `ids` | `string`[] | -| `object` | `string` | +| `id` | `string` | +| `object` | ``"payment_collection"`` | #### Defined in -medusa/dist/api/routes/admin/price-lists/index.d.ts:13 +medusa/dist/api/routes/admin/payment-collections/index.d.ts:10 ___ -### AdminPriceListRes +### AdminPaymentCollectionRes -Ƭ **AdminPriceListRes**: `Object` +Ƭ **AdminPaymentCollectionRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `price_list` | [`PriceList`](../classes/internal.PriceList.md) | +| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.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**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:174 +medusa/dist/api/routes/admin/payment-collections/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-16.md b/docs/content/references/js-client/modules/internal-16.md index 114e20bfbe..57cb9c9bdd 100644 --- a/docs/content/references/js-client/modules/internal-16.md +++ b/docs/content/references/js-client/modules/internal-16.md @@ -1,16 +1,42 @@ # Namespace: internal +## Enumerations + +- [RefundReason](../enums/internal-16.RefundReason.md) + ## Classes -- [AdminGetProductTagsPaginationParams](../classes/internal-16.AdminGetProductTagsPaginationParams.md) -- [AdminGetProductTagsParams](../classes/internal-16.AdminGetProductTagsParams.md) +- [AdminPostPaymentRefundsReq](../classes/internal-16.AdminPostPaymentRefundsReq.md) +- [GetPaymentsParams](../classes/internal-16.GetPaymentsParams.md) ## Type Aliases -### AdminProductTagsListRes +### AdminPaymentRes -Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] } +Ƭ **AdminPaymentRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](../classes/internal.Payment.md) | #### Defined in -medusa/dist/api/routes/admin/product-tags/index.d.ts:9 +medusa/dist/api/routes/admin/payments/index.d.ts:6 + +___ + +### AdminRefundRes + +Ƭ **AdminRefundRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `refund` | [`Refund`](../classes/internal.Refund.md) | + +#### Defined in + +medusa/dist/api/routes/admin/payments/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 71c54bad19..877d076857 100644 --- a/docs/content/references/js-client/modules/internal-17.md +++ b/docs/content/references/js-client/modules/internal-17.md @@ -2,14 +2,68 @@ ## Classes -- [AdminGetProductTypesParams](../classes/internal-17.AdminGetProductTypesParams.md) +- [AdminDeletePriceListPricesPricesReq](../classes/internal-17.AdminDeletePriceListPricesPricesReq.md) +- [AdminGetPriceListPaginationParams](../classes/internal-17.AdminGetPriceListPaginationParams.md) +- [AdminGetPriceListsPriceListProductsParams](../classes/internal-17.AdminGetPriceListsPriceListProductsParams.md) +- [AdminPostPriceListPricesPricesReq](../classes/internal-17.AdminPostPriceListPricesPricesReq.md) +- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md) +- [AdminPostPriceListsPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListReq.md) +- [AdminPriceListPricesCreateReq](../classes/internal-17.AdminPriceListPricesCreateReq.md) +- [AdminPriceListPricesUpdateReq](../classes/internal-17.AdminPriceListPricesUpdateReq.md) +- [CustomerGroup](../classes/internal-17.CustomerGroup.md) +- [CustomerGroup](../classes/internal-17.CustomerGroup-1.md) +- [FilterablePriceListProps](../classes/internal-17.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**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_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-18.md b/docs/content/references/js-client/modules/internal-18.md index 2f741813fc..51571db277 100644 --- a/docs/content/references/js-client/modules/internal-18.md +++ b/docs/content/references/js-client/modules/internal-18.md @@ -2,210 +2,15 @@ ## Classes -- [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) +- [AdminGetProductTagsPaginationParams](../classes/internal-18.AdminGetProductTagsPaginationParams.md) +- [AdminGetProductTagsParams](../classes/internal-18.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-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 +medusa/dist/api/routes/admin/product-tags/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-19.md b/docs/content/references/js-client/modules/internal-19.md index 70f01f8378..5bc00b07e5 100644 --- a/docs/content/references/js-client/modules/internal-19.md +++ b/docs/content/references/js-client/modules/internal-19.md @@ -2,23 +2,14 @@ ## Classes -- [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) +- [AdminGetProductTypesParams](../classes/internal-19.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:12 +medusa/dist/api/routes/admin/product-types/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-20.md b/docs/content/references/js-client/modules/internal-20.md index 034da63bd0..a9535c89ca 100644 --- a/docs/content/references/js-client/modules/internal-20.md +++ b/docs/content/references/js-client/modules/internal-20.md @@ -2,37 +2,210 @@ ## Classes -- [AdminPostReturnReasonsReasonReq](../classes/internal-20.AdminPostReturnReasonsReasonReq.md) -- [AdminPostReturnReasonsReq](../classes/internal-20.AdminPostReturnReasonsReq.md) +- [AdminGetProductsParams](../classes/internal-20.AdminGetProductsParams.md) +- [AdminPostProductsProductMetadataReq](../classes/internal-20.AdminPostProductsProductMetadataReq.md) +- [AdminPostProductsProductOptionsOption](../classes/internal-20.AdminPostProductsProductOptionsOption.md) +- [AdminPostProductsProductOptionsReq](../classes/internal-20.AdminPostProductsProductOptionsReq.md) +- [AdminPostProductsProductReq](../classes/internal-20.AdminPostProductsProductReq.md) +- [AdminPostProductsProductVariantsReq](../classes/internal-20.AdminPostProductsProductVariantsReq.md) +- [AdminPostProductsProductVariantsVariantReq](../classes/internal-20.AdminPostProductsProductVariantsVariantReq.md) +- [AdminPostProductsReq](../classes/internal-20.AdminPostProductsReq.md) +- [FilterableProductProps](../classes/internal-20.FilterableProductProps.md) +- [ProductOptionReq](../classes/internal-20.ProductOptionReq.md) +- [ProductSalesChannelReq](../classes/internal-20.ProductSalesChannelReq.md) +- [ProductTagReq](../classes/internal-20.ProductTagReq.md) +- [ProductTypeReq](../classes/internal-20.ProductTypeReq.md) +- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq.md) +- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-1.md) +- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-2.md) +- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-3.md) +- [ProductVariantPricesCreateReq](../classes/internal-20.ProductVariantPricesCreateReq.md) +- [ProductVariantPricesUpdateReq](../classes/internal-20.ProductVariantPricesUpdateReq.md) +- [ProductVariantReq](../classes/internal-20.ProductVariantReq.md) +- [ProductVariantReq](../classes/internal-20.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-20.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-20.md#pricedvariant)[] } + +#### Defined in + +medusa/dist/types/pricing.d.ts:31 + +___ + +### PricedVariant + +Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-20.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-20.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:15 + +___ + +### 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-20.md#taxservicerate)[] \| ``null`` | + +#### Defined in + +medusa/dist/types/pricing.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-21.md b/docs/content/references/js-client/modules/internal-21.md index 03818fa624..09f828c4e1 100644 --- a/docs/content/references/js-client/modules/internal-21.md +++ b/docs/content/references/js-client/modules/internal-21.md @@ -2,48 +2,43 @@ ## Classes -- [AdminGetReturnsParams](../classes/internal-21.AdminGetReturnsParams.md) -- [AdminPostReturnsReturnReceiveReq](../classes/internal-21.AdminPostReturnsReturnReceiveReq.md) -- [Item](../classes/internal-21.Item.md) +- [AdminPostPublishableApiKeysPublishableApiKeyReq](../classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md) +- [AdminPostPublishableApiKeysReq](../classes/internal-21.AdminPostPublishableApiKeysReq.md) +- [GetPublishableApiKeysParams](../classes/internal-21.GetPublishableApiKeysParams.md) +- [PublishableApiKey](../classes/internal-21.PublishableApiKey.md) ## Type Aliases -### AdminReturnsCancelRes +### AdminPublishableApiKeysListRes -Ƭ **AdminReturnsCancelRes**: `Object` +Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:8 + +___ + +### AdminPublishableApiKeysRes + +Ƭ **AdminPublishableApiKeysRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | +| `publishable_api_key` | [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md) | #### Defined in -medusa/dist/api/routes/admin/returns/index.d.ts:6 +medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:5 -___ +## Variables -### AdminReturnsListRes +### GetPublishableApiKeysParams\_base -Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] } +• `Const` **GetPublishableApiKeysParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.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/publishable-api-keys/list-publishable-api-keys.d.ts:60 diff --git a/docs/content/references/js-client/modules/internal-22.md b/docs/content/references/js-client/modules/internal-22.md index 416c19e67d..07a8b23a1e 100644 --- a/docs/content/references/js-client/modules/internal-22.md +++ b/docs/content/references/js-client/modules/internal-22.md @@ -2,45 +2,23 @@ ## Classes -- [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) +- [AdminGetRegionsPaginationParams](../classes/internal-22.AdminGetRegionsPaginationParams.md) +- [AdminGetRegionsParams](../classes/internal-22.AdminGetRegionsParams.md) +- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md) +- [AdminPostRegionsRegionCountriesReq](../classes/internal-22.AdminPostRegionsRegionCountriesReq.md) +- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md) +- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md) +- [AdminPostRegionsRegionReq](../classes/internal-22.AdminPostRegionsRegionReq.md) +- [AdminPostRegionsReq](../classes/internal-22.AdminPostRegionsReq.md) +- [AdminRegionsRes](../classes/internal-22.AdminRegionsRes.md) +- [FulfillmentOption](../classes/internal-22.FulfillmentOption.md) ## Type Aliases -### AdminSalesChannelsListRes +### AdminRegionsListRes -Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] } +Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] } #### Defined in -medusa/dist/api/routes/admin/sales-channels/index.d.ts:10 - -___ - -### AdminSalesChannelsRes - -Ƭ **AdminSalesChannelsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) | - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/index.d.ts:6 - -## Variables - -### AdminGetSalesChannelsParams\_base - -• `Const` **AdminGetSalesChannelsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:141 +medusa/dist/api/routes/admin/regions/index.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-23.md b/docs/content/references/js-client/modules/internal-23.md index 2d08b3547e..aaeb8f6c1d 100644 --- a/docs/content/references/js-client/modules/internal-23.md +++ b/docs/content/references/js-client/modules/internal-23.md @@ -2,34 +2,37 @@ ## Classes -- [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) +- [AdminPostReturnReasonsReasonReq](../classes/internal-23.AdminPostReturnReasonsReasonReq.md) +- [AdminPostReturnReasonsReq](../classes/internal-23.AdminPostReturnReasonsReq.md) ## Type Aliases -### AdminShippingOptionsListRes +### AdminReturnReasonsListRes -Ƭ **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:8 - -___ - -### AdminShippingOptionsRes - -Ƭ **AdminShippingOptionsRes**: `Object` +Ƭ **AdminReturnReasonsListRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) | +| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | #### Defined in -medusa/dist/api/routes/admin/shipping-options/index.d.ts:11 +medusa/dist/api/routes/admin/return-reasons/index.d.ts:10 + +___ + +### AdminReturnReasonsRes + +Ƭ **AdminReturnReasonsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-24.md b/docs/content/references/js-client/modules/internal-24.md index e45927ec04..e016461177 100644 --- a/docs/content/references/js-client/modules/internal-24.md +++ b/docs/content/references/js-client/modules/internal-24.md @@ -2,37 +2,48 @@ ## Classes -- [AdminPostShippingProfilesProfileReq](../classes/internal-24.AdminPostShippingProfilesProfileReq.md) -- [AdminPostShippingProfilesReq](../classes/internal-24.AdminPostShippingProfilesReq.md) +- [AdminGetReturnsParams](../classes/internal-24.AdminGetReturnsParams.md) +- [AdminPostReturnsReturnReceiveReq](../classes/internal-24.AdminPostReturnsReturnReceiveReq.md) +- [Item](../classes/internal-24.Item.md) ## Type Aliases -### AdminShippingProfilesListRes +### AdminReturnsCancelRes -Ƭ **AdminShippingProfilesListRes**: `Object` +Ƭ **AdminReturnsCancelRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] | +| `order` | [`Order`](../classes/internal.Order.md) | #### Defined in -medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12 +medusa/dist/api/routes/admin/returns/index.d.ts:6 ___ -### AdminShippingProfilesRes +### AdminReturnsListRes -Ƭ **AdminShippingProfilesRes**: `Object` +Ƭ **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 | | :------ | :------ | -| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) | +| `return` | [`Return`](../classes/internal.Return.md) | #### Defined in -medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9 +medusa/dist/api/routes/admin/returns/index.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-25.md b/docs/content/references/js-client/modules/internal-25.md index 96f26535e7..a514da34a5 100644 --- a/docs/content/references/js-client/modules/internal-25.md +++ b/docs/content/references/js-client/modules/internal-25.md @@ -2,53 +2,45 @@ ## Classes -- [AdminPostStoreReq](../classes/internal-25.AdminPostStoreReq.md) -- [Store](../classes/internal-25.Store.md) +- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md) +- [AdminGetSalesChannelsParams](../classes/internal-25.AdminGetSalesChannelsParams.md) +- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md) +- [AdminPostSalesChannelsReq](../classes/internal-25.AdminPostSalesChannelsReq.md) +- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md) +- [ProductBatchSalesChannel](../classes/internal-25.ProductBatchSalesChannel.md) ## Type Aliases -### AdminPaymentProvidersList +### AdminSalesChannelsListRes -Ƭ **AdminPaymentProvidersList**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] | +Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] } #### Defined in -medusa/dist/api/routes/admin/store/index.d.ts:10 +medusa/dist/api/routes/admin/sales-channels/index.d.ts:10 ___ -### AdminStoresRes +### AdminSalesChannelsRes -Ƭ **AdminStoresRes**: `Object` +Ƭ **AdminSalesChannelsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `store` | [`Store`](../classes/internal-25.Store.md) | +| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) | #### Defined in -medusa/dist/api/routes/admin/store/index.d.ts:4 +medusa/dist/api/routes/admin/sales-channels/index.d.ts:6 -___ +## Variables -### AdminTaxProvidersList +### AdminGetSalesChannelsParams\_base -Ƭ **AdminTaxProvidersList**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] | +• `Const` **AdminGetSalesChannelsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) #### Defined in -medusa/dist/api/routes/admin/store/index.d.ts:7 +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:141 diff --git a/docs/content/references/js-client/modules/internal-26.md b/docs/content/references/js-client/modules/internal-26.md index 23cb3b8dc7..8f01dd1821 100644 --- a/docs/content/references/js-client/modules/internal-26.md +++ b/docs/content/references/js-client/modules/internal-26.md @@ -2,30 +2,34 @@ ## Classes -- [AdminGetSwapsParams](../classes/internal-26.AdminGetSwapsParams.md) +- [AdminGetShippingOptionsParams](../classes/internal-26.AdminGetShippingOptionsParams.md) +- [AdminPostShippingOptionsOptionReq](../classes/internal-26.AdminPostShippingOptionsOptionReq.md) +- [AdminPostShippingOptionsReq](../classes/internal-26.AdminPostShippingOptionsReq.md) +- [OptionRequirement](../classes/internal-26.OptionRequirement.md) +- [OptionRequirement](../classes/internal-26.OptionRequirement-1.md) ## Type Aliases -### AdminSwapsListRes +### AdminShippingOptionsListRes -Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] } +Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] } #### Defined in -medusa/dist/api/routes/admin/swaps/index.d.ts:7 +medusa/dist/api/routes/admin/shipping-options/index.d.ts:8 ___ -### AdminSwapsRes +### AdminShippingOptionsRes -Ƭ **AdminSwapsRes**: `Object` +Ƭ **AdminShippingOptionsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `swap` | [`Swap`](../classes/internal.Swap.md) | +| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) | #### Defined in -medusa/dist/api/routes/admin/swaps/index.d.ts:10 +medusa/dist/api/routes/admin/shipping-options/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-27.md b/docs/content/references/js-client/modules/internal-27.md index 8dbc33fe8d..5afd67c270 100644 --- a/docs/content/references/js-client/modules/internal-27.md +++ b/docs/content/references/js-client/modules/internal-27.md @@ -2,43 +2,37 @@ ## Classes -- [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) +- [AdminPostShippingProfilesProfileReq](../classes/internal-27.AdminPostShippingProfilesProfileReq.md) +- [AdminPostShippingProfilesReq](../classes/internal-27.AdminPostShippingProfilesReq.md) ## Type Aliases -### AdminTaxRatesListRes +### AdminShippingProfilesListRes -Ƭ **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` +Ƭ **AdminShippingProfilesListRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) | +| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] | #### Defined in -medusa/dist/api/routes/admin/tax-rates/index.d.ts:11 +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-28.md b/docs/content/references/js-client/modules/internal-28.md index 731ee69a92..9b4b21d6f8 100644 --- a/docs/content/references/js-client/modules/internal-28.md +++ b/docs/content/references/js-client/modules/internal-28.md @@ -2,38 +2,53 @@ ## Classes -- [AdminDeleteUploadsReq](../classes/internal-28.AdminDeleteUploadsReq.md) -- [AdminPostUploadsDownloadUrlReq](../classes/internal-28.AdminPostUploadsDownloadUrlReq.md) -- [IAdminPostUploadsFileReq](../classes/internal-28.IAdminPostUploadsFileReq.md) +- [AdminPostStoreReq](../classes/internal-28.AdminPostStoreReq.md) +- [Store](../classes/internal-28.Store.md) ## Type Aliases -### AdminUploadsDownloadUrlRes +### AdminPaymentProvidersList -Ƭ **AdminUploadsDownloadUrlRes**: `Object` +Ƭ **AdminPaymentProvidersList**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `download_url` | `string` | +| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] | #### Defined in -medusa/dist/api/routes/admin/uploads/index.d.ts:10 +medusa/dist/api/routes/admin/store/index.d.ts:10 ___ -### AdminUploadsRes +### AdminStoresRes -Ƭ **AdminUploadsRes**: `Object` +Ƭ **AdminStoresRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `uploads` | { `url`: `string` }[] | +| `store` | [`Store`](../classes/internal-28.Store.md) | #### Defined in -medusa/dist/api/routes/admin/uploads/index.d.ts:4 +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-29.md b/docs/content/references/js-client/modules/internal-29.md index ca68b6416e..96859d3105 100644 --- a/docs/content/references/js-client/modules/internal-29.md +++ b/docs/content/references/js-client/modules/internal-29.md @@ -2,115 +2,30 @@ ## Classes -- [AdminCreateUserRequest](../classes/internal-29.AdminCreateUserRequest.md) -- [AdminResetPasswordRequest](../classes/internal-29.AdminResetPasswordRequest.md) -- [AdminResetPasswordTokenRequest](../classes/internal-29.AdminResetPasswordTokenRequest.md) -- [AdminUpdateUserRequest](../classes/internal-29.AdminUpdateUserRequest.md) +- [AdminGetSwapsParams](../classes/internal-29.AdminGetSwapsParams.md) ## Type Aliases -### AdminCreateUserPayload +### AdminSwapsListRes -Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-29.md#createuserroles) } +Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] } #### Defined in -[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L31) +medusa/dist/api/routes/admin/swaps/index.d.ts:7 ___ -### AdminUpdateUserPayload +### AdminSwapsRes -Ƭ **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/a4dd26e13/packages/medusa-js/src/typings.ts#L41) - -___ - -### AdminUserRes - -Ƭ **AdminUserRes**: `Object` +Ƭ **AdminSwapsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | +| `swap` | [`Swap`](../classes/internal.Swap.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/a4dd26e13/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/a4dd26e13/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/a4dd26e13/packages/medusa-js/src/typings.ts#L23) - -___ - -### UpdateUserRoles - -Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` - -#### Defined in - -[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/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/a4dd26e13/packages/medusa-js/src/typings.ts#L37) +medusa/dist/api/routes/admin/swaps/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-30.md b/docs/content/references/js-client/modules/internal-30.md index 7b37eafb50..9ac388e0a1 100644 --- a/docs/content/references/js-client/modules/internal-30.md +++ b/docs/content/references/js-client/modules/internal-30.md @@ -2,16 +2,43 @@ ## Classes -- [AdminGetVariantsParams](../classes/internal-30.AdminGetVariantsParams.md) -- [AdminPriceSelectionParams](../classes/internal-30.AdminPriceSelectionParams.md) -- [PriceSelectionParams](../classes/internal-30.PriceSelectionParams.md) +- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md) +- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md) +- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md) +- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md) +- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) +- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) +- [AdminGetTaxRatesParams](../classes/internal-30.AdminGetTaxRatesParams.md) +- [AdminGetTaxRatesTaxRateParams](../classes/internal-30.AdminGetTaxRatesTaxRateParams.md) +- [AdminPostTaxRatesReq](../classes/internal-30.AdminPostTaxRatesReq.md) +- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md) +- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md) +- [AdminPostTaxRatesTaxRateReq](../classes/internal-30.AdminPostTaxRatesTaxRateReq.md) +- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md) +- [NumericalComparisonOperator](../classes/internal-30.NumericalComparisonOperator.md) ## Type Aliases -### AdminVariantsListRes +### AdminTaxRatesListRes -Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-18.md#pricedvariant)[] } +Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] } #### Defined in -medusa/dist/api/routes/admin/variants/index.d.ts:10 +medusa/dist/api/routes/admin/tax-rates/index.d.ts:8 + +___ + +### AdminTaxRatesRes + +Ƭ **AdminTaxRatesRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) | + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-31.md b/docs/content/references/js-client/modules/internal-31.md index d10d57a1b8..e585946cf7 100644 --- a/docs/content/references/js-client/modules/internal-31.md +++ b/docs/content/references/js-client/modules/internal-31.md @@ -2,36 +2,38 @@ ## Classes -- [StorePostAuthReq](../classes/internal-31.StorePostAuthReq.md) +- [AdminDeleteUploadsReq](../classes/internal-31.AdminDeleteUploadsReq.md) +- [AdminPostUploadsDownloadUrlReq](../classes/internal-31.AdminPostUploadsDownloadUrlReq.md) +- [IAdminPostUploadsFileReq](../classes/internal-31.IAdminPostUploadsFileReq.md) ## Type Aliases -### StoreAuthRes +### AdminUploadsDownloadUrlRes -Ƭ **StoreAuthRes**: `Object` +Ƭ **AdminUploadsDownloadUrlRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `customer` | [`Customer`](../classes/internal.Customer.md) | +| `download_url` | `string` | #### Defined in -medusa/dist/api/routes/store/auth/index.d.ts:4 +medusa/dist/api/routes/admin/uploads/index.d.ts:10 ___ -### StoreGetAuthEmailRes +### AdminUploadsRes -Ƭ **StoreGetAuthEmailRes**: `Object` +Ƭ **AdminUploadsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `exists` | `boolean` | +| `uploads` | { `url`: `string` }[] | #### Defined in -medusa/dist/api/routes/store/auth/index.d.ts:7 +medusa/dist/api/routes/admin/uploads/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-32.md b/docs/content/references/js-client/modules/internal-32.md index 987d72df8d..739ce6daeb 100644 --- a/docs/content/references/js-client/modules/internal-32.md +++ b/docs/content/references/js-client/modules/internal-32.md @@ -2,37 +2,115 @@ ## Classes -- [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) +- [AdminCreateUserRequest](../classes/internal-32.AdminCreateUserRequest.md) +- [AdminResetPasswordRequest](../classes/internal-32.AdminResetPasswordRequest.md) +- [AdminResetPasswordTokenRequest](../classes/internal-32.AdminResetPasswordTokenRequest.md) +- [AdminUpdateUserRequest](../classes/internal-32.AdminUpdateUserRequest.md) ## Type Aliases -### StoreCartsRes +### AdminCreateUserPayload -Ƭ **StoreCartsRes**: `Object` +Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-32.md#createuserroles) } + +#### Defined in + +[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L31) + +___ + +### AdminUpdateUserPayload + +Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-32.md#updateuserroles) } + +#### Defined in + +[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L41) + +___ + +### AdminUserRes + +Ƭ **AdminUserRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> | +| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | #### Defined in -medusa/dist/api/routes/store/carts/index.d.ts:8 +medusa/dist/api/routes/admin/users/index.d.ts:6 ___ -### StoreCompleteCartRes +### AdminUsersListRes -Ƭ **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"`` } +Ƭ **AdminUsersListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] | #### Defined in -medusa/dist/api/routes/store/carts/index.d.ts:11 +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/105c68929/packages/medusa-js/src/typings.ts#L28) + +___ + +### CreateUserRolesEnum + +Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md)[``"role"``]\> + +#### Defined in + +[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/105c68929/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/105c68929/packages/medusa-js/src/typings.ts#L23) + +___ + +### UpdateUserRoles + +Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` + +#### Defined in + +[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L39) + +___ + +### UpdateUserRolesEnum + +Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md)[``"role"``]\> + +#### Defined in + +[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L37) diff --git a/docs/content/references/js-client/modules/internal-33.md b/docs/content/references/js-client/modules/internal-33.md index 301fdceb62..9ff582d6e1 100644 --- a/docs/content/references/js-client/modules/internal-33.md +++ b/docs/content/references/js-client/modules/internal-33.md @@ -2,30 +2,16 @@ ## Classes -- [StoreGetCollectionsParams](../classes/internal-33.StoreGetCollectionsParams.md) +- [AdminGetVariantsParams](../classes/internal-33.AdminGetVariantsParams.md) +- [AdminPriceSelectionParams](../classes/internal-33.AdminPriceSelectionParams.md) +- [PriceSelectionParams](../classes/internal-33.PriceSelectionParams.md) ## Type Aliases -### StoreCollectionsListRes +### AdminVariantsListRes -Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] } +Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-20.md#pricedvariant)[] } #### Defined in -medusa/dist/api/routes/store/collections/index.d.ts:7 - -___ - -### StoreCollectionsRes - -Ƭ **StoreCollectionsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) | - -#### Defined in - -medusa/dist/api/routes/store/collections/index.d.ts:10 +medusa/dist/api/routes/admin/variants/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 f01382088e..b34e6ba16b 100644 --- a/docs/content/references/js-client/modules/internal-34.md +++ b/docs/content/references/js-client/modules/internal-34.md @@ -2,19 +2,36 @@ ## Classes -- [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) +- [StorePostAuthReq](../classes/internal-34.StorePostAuthReq.md) ## Type Aliases -### StoreCustomersListOrdersRes +### StoreAuthRes -Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } +Ƭ **StoreAuthRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer` | [`Customer`](../classes/internal.Customer.md) | #### Defined in -medusa/dist/api/routes/store/customers/index.d.ts:12 +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-35.md b/docs/content/references/js-client/modules/internal-35.md index 52a8616e22..6413505cb0 100644 --- a/docs/content/references/js-client/modules/internal-35.md +++ b/docs/content/references/js-client/modules/internal-35.md @@ -1,17 +1,38 @@ # Namespace: internal +## Classes + +- [Discount](../classes/internal-35.Discount.md) +- [GiftCard](../classes/internal-35.GiftCard.md) +- [Item](../classes/internal-35.Item.md) +- [StorePostCartReq](../classes/internal-35.StorePostCartReq.md) +- [StorePostCartsCartPaymentSessionReq](../classes/internal-35.StorePostCartsCartPaymentSessionReq.md) +- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md) +- [StorePostCartsCartReq](../classes/internal-35.StorePostCartsCartReq.md) +- [StorePostCartsCartShippingMethodReq](../classes/internal-35.StorePostCartsCartShippingMethodReq.md) + ## Type Aliases -### StoreGiftCardsRes +### StoreCartsRes -Ƭ **StoreGiftCardsRes**: `Object` +Ƭ **StoreCartsRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | +| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> | #### Defined in -medusa/dist/api/routes/store/gift-cards/index.d.ts:8 +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-36.md b/docs/content/references/js-client/modules/internal-36.md index b0bdadde0c..3c9f7a59da 100644 --- a/docs/content/references/js-client/modules/internal-36.md +++ b/docs/content/references/js-client/modules/internal-36.md @@ -2,5 +2,30 @@ ## Classes -- [StorePostCartsCartLineItemsItemReq](../classes/internal-36.StorePostCartsCartLineItemsItemReq.md) -- [StorePostCartsCartLineItemsReq](../classes/internal-36.StorePostCartsCartLineItemsReq.md) +- [StoreGetCollectionsParams](../classes/internal-36.StoreGetCollectionsParams.md) + +## Type Aliases + +### StoreCollectionsListRes + +Ƭ **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 | +| :------ | :------ | +| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) | + +#### Defined in + +medusa/dist/api/routes/store/collections/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-37.md b/docs/content/references/js-client/modules/internal-37.md index 40ad722772..c3b8c108f3 100644 --- a/docs/content/references/js-client/modules/internal-37.md +++ b/docs/content/references/js-client/modules/internal-37.md @@ -2,20 +2,19 @@ ## Classes -- [StorePostOrderEditsOrderEditDecline](../classes/internal-37.StorePostOrderEditsOrderEditDecline.md) +- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md) +- [StoreGetCustomersCustomerOrdersParams](../classes/internal-37.StoreGetCustomersCustomerOrdersParams.md) +- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md) +- [StorePostCustomersCustomerReq](../classes/internal-37.StorePostCustomersCustomerReq.md) +- [StorePostCustomersReq](../classes/internal-37.StorePostCustomersReq.md) +- [StorePostCustomersResetPasswordReq](../classes/internal-37.StorePostCustomersResetPasswordReq.md) ## Type Aliases -### StoreOrderEditsRes +### StoreCustomersListOrdersRes -Ƭ **StoreOrderEditsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> | +Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } #### Defined in -medusa/dist/api/routes/store/order-edits/index.d.ts:4 +medusa/dist/api/routes/store/customers/index.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-38.md b/docs/content/references/js-client/modules/internal-38.md index 7407660859..52a8616e22 100644 --- a/docs/content/references/js-client/modules/internal-38.md +++ b/docs/content/references/js-client/modules/internal-38.md @@ -1,22 +1,17 @@ # Namespace: internal -## Classes - -- [ShippingAddressPayload](../classes/internal-38.ShippingAddressPayload.md) -- [StoreGetOrdersParams](../classes/internal-38.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-39.md b/docs/content/references/js-client/modules/internal-39.md index 4c6cd3245f..01a07e9994 100644 --- a/docs/content/references/js-client/modules/internal-39.md +++ b/docs/content/references/js-client/modules/internal-39.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-39.StorePostCartsCartLineItemsItemReq.md) +- [StorePostCartsCartLineItemsReq](../classes/internal-39.StorePostCartsCartLineItemsReq.md) diff --git a/docs/content/references/js-client/modules/internal-40.md b/docs/content/references/js-client/modules/internal-40.md index 5bdd7db249..2254f2ed1c 100644 --- a/docs/content/references/js-client/modules/internal-40.md +++ b/docs/content/references/js-client/modules/internal-40.md @@ -2,14 +2,20 @@ ## Classes -- [StoreGetProductTypesParams](../classes/internal-40.StoreGetProductTypesParams.md) +- [StorePostOrderEditsOrderEditDecline](../classes/internal-40.StorePostOrderEditsOrderEditDecline.md) ## Type Aliases -### StoreProductTypesListRes +### StoreOrderEditsRes -Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] } +Ƭ **StoreOrderEditsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> | #### Defined in -medusa/dist/api/routes/store/product-types/index.d.ts:9 +medusa/dist/api/routes/store/order-edits/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-41.md b/docs/content/references/js-client/modules/internal-41.md index 62979068ed..2567436376 100644 --- a/docs/content/references/js-client/modules/internal-41.md +++ b/docs/content/references/js-client/modules/internal-41.md @@ -2,30 +2,21 @@ ## Classes -- [StoreGetVariantsParams](../classes/internal-41.StoreGetVariantsParams.md) +- [ShippingAddressPayload](../classes/internal-41.ShippingAddressPayload.md) +- [StoreGetOrdersParams](../classes/internal-41.StoreGetOrdersParams.md) ## Type Aliases -### StoreVariantsListRes +### StoreOrdersRes -Ƭ **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` +Ƭ **StoreOrdersRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) | +| `order` | [`Order`](../classes/internal.Order.md) | #### Defined in -medusa/dist/api/routes/store/variants/index.d.ts:6 +medusa/dist/api/routes/store/orders/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 823afd474f..22693cfd5f 100644 --- a/docs/content/references/js-client/modules/internal-42.md +++ b/docs/content/references/js-client/modules/internal-42.md @@ -2,52 +2,38 @@ ## Classes -- [StoreGetProductsPaginationParams](../classes/internal-42.StoreGetProductsPaginationParams.md) -- [StoreGetProductsParams](../classes/internal-42.StoreGetProductsParams.md) -- [StorePostSearchReq](../classes/internal-42.StorePostSearchReq.md) +- [PaymentCollectionSessionInputRequest](../classes/internal-42.PaymentCollectionSessionInputRequest.md) +- [StoreManagePaymentCollectionSessionRequest](../classes/internal-42.StoreManagePaymentCollectionSessionRequest.md) +- [StoreRefreshPaymentCollectionSessionRequest](../classes/internal-42.StoreRefreshPaymentCollectionSessionRequest.md) ## Type Aliases -### StorePostSearchRes +### StorePaymentCollectionRes -Ƭ **StorePostSearchRes**: `Object` - -#### Index signature - -▪ [k: `string`]: `unknown` +Ƭ **StorePaymentCollectionRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `hits` | `unknown`[] | +| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) | #### Defined in -medusa/dist/api/routes/store/products/index.d.ts:12 +medusa/dist/api/routes/store/payment-collections/index.d.ts:7 ___ -### StoreProductsListRes +### StorePaymentCollectionSessionRes -Ƭ **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` +Ƭ **StorePaymentCollectionSessionRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `product` | [`Product`](../classes/internal.Product.md) | +| `payment_session` | [`PaymentSession`](../classes/internal.PaymentSession.md) | #### Defined in -medusa/dist/api/routes/store/products/index.d.ts:9 +medusa/dist/api/routes/store/payment-collections/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-43.md b/docs/content/references/js-client/modules/internal-43.md index 1235343f30..4c6cd3245f 100644 --- a/docs/content/references/js-client/modules/internal-43.md +++ b/docs/content/references/js-client/modules/internal-43.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-44.md b/docs/content/references/js-client/modules/internal-44.md index 20dac0fd61..fdc80dc807 100644 --- a/docs/content/references/js-client/modules/internal-44.md +++ b/docs/content/references/js-client/modules/internal-44.md @@ -1,33 +1,15 @@ # Namespace: internal +## Classes + +- [StoreGetProductTypesParams](../classes/internal-44.StoreGetProductTypesParams.md) + ## Type Aliases -### StoreReturnReasonsListRes +### StoreProductTypesListRes -Ƭ **StoreReturnReasonsListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | +Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] } #### Defined in -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 +medusa/dist/api/routes/store/product-types/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-45.md b/docs/content/references/js-client/modules/internal-45.md index 614fc6505e..e5dff6c50a 100644 --- a/docs/content/references/js-client/modules/internal-45.md +++ b/docs/content/references/js-client/modules/internal-45.md @@ -2,22 +2,30 @@ ## Classes -- [Item](../classes/internal-45.Item.md) -- [ReturnShipping](../classes/internal-45.ReturnShipping.md) -- [StorePostReturnsReq](../classes/internal-45.StorePostReturnsReq.md) +- [StoreGetVariantsParams](../classes/internal-45.StoreGetVariantsParams.md) ## Type Aliases -### StoreReturnsRes +### StoreVariantsListRes -Ƭ **StoreReturnsRes**: `Object` +Ƭ **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` #### Type declaration | Name | Type | | :------ | :------ | -| `return` | [`Return`](../classes/internal.Return.md) | +| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) | #### Defined in -medusa/dist/api/routes/store/returns/index.d.ts:4 +medusa/dist/api/routes/store/variants/index.d.ts:6 diff --git a/docs/content/references/js-client/modules/internal-46.md b/docs/content/references/js-client/modules/internal-46.md index 07458a9b56..915c5ee409 100644 --- a/docs/content/references/js-client/modules/internal-46.md +++ b/docs/content/references/js-client/modules/internal-46.md @@ -2,20 +2,52 @@ ## Classes -- [StoreGetShippingOptionsParams](../classes/internal-46.StoreGetShippingOptionsParams.md) +- [StoreGetProductsPaginationParams](../classes/internal-46.StoreGetProductsPaginationParams.md) +- [StoreGetProductsParams](../classes/internal-46.StoreGetProductsParams.md) +- [StorePostSearchReq](../classes/internal-46.StorePostSearchReq.md) ## Type Aliases -### StoreShippingOptionsListRes +### StorePostSearchRes -Ƭ **StoreShippingOptionsListRes**: `Object` +Ƭ **StorePostSearchRes**: `Object` + +#### Index signature + +▪ [k: `string`]: `unknown` #### Type declaration | Name | Type | | :------ | :------ | -| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] | +| `hits` | `unknown`[] | #### Defined in -medusa/dist/api/routes/store/shipping-options/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-47.md b/docs/content/references/js-client/modules/internal-47.md index 761e1be94c..1235343f30 100644 --- a/docs/content/references/js-client/modules/internal-47.md +++ b/docs/content/references/js-client/modules/internal-47.md @@ -1,23 +1,33 @@ # Namespace: internal -## Classes - -- [AdditionalItem](../classes/internal-47.AdditionalItem.md) -- [Item](../classes/internal-47.Item.md) -- [StorePostSwapsReq](../classes/internal-47.StorePostSwapsReq.md) - ## Type Aliases -### StoreSwapsRes +### StoreRegionsListRes -Ƭ **StoreSwapsRes**: `Object` +Ƭ **StoreRegionsListRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `swap` | [`Swap`](../classes/internal.Swap.md) | +| `regions` | [`Region`](../classes/internal.Region.md)[] | #### Defined in -medusa/dist/api/routes/store/swaps/index.d.ts:7 +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-48.md b/docs/content/references/js-client/modules/internal-48.md new file mode 100644 index 0000000000..20dac0fd61 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-48.md @@ -0,0 +1,33 @@ +# Namespace: internal + +## Type Aliases + +### StoreReturnReasonsListRes + +Ƭ **StoreReturnReasonsListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | + +#### Defined in + +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-49.md b/docs/content/references/js-client/modules/internal-49.md new file mode 100644 index 0000000000..d19bea89e1 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-49.md @@ -0,0 +1,23 @@ +# Namespace: internal + +## Classes + +- [Item](../classes/internal-49.Item.md) +- [ReturnShipping](../classes/internal-49.ReturnShipping.md) +- [StorePostReturnsReq](../classes/internal-49.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-50.md b/docs/content/references/js-client/modules/internal-50.md new file mode 100644 index 0000000000..c56c68a595 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-50.md @@ -0,0 +1,21 @@ +# Namespace: internal + +## Classes + +- [StoreGetShippingOptionsParams](../classes/internal-50.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-51.md b/docs/content/references/js-client/modules/internal-51.md new file mode 100644 index 0000000000..939d069c35 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-51.md @@ -0,0 +1,23 @@ +# Namespace: internal + +## Classes + +- [AdditionalItem](../classes/internal-51.AdditionalItem.md) +- [Item](../classes/internal-51.Item.md) +- [StorePostSwapsReq](../classes/internal-51.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-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md b/docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md index eaef46ac4d..59e0ec779a 100644 --- a/docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md +++ b/docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md @@ -29,6 +29,8 @@ ___ | Name | Type | | :------ | :------ | | `featureFlags` | `Record`<`string`, `boolean` \| `string`\> | +| `moduleResolutions?` | `Record`<`string`, [`ModuleResolution`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduleresolution)\> | +| `modules?` | `Record`<`string`, `string`\> | | `plugins` | ({ `options`: `Record`<`string`, `unknown`\> ; `resolve`: `string` } \| `string`)[] | | `projectConfig` | { `admin_cors?`: `string` ; `cookie_secret?`: `string` ; `database_database?`: `string` ; `database_extra?`: `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } ; `database_logging`: `LoggerOptions` ; `database_type`: `string` ; `database_url?`: `string` ; `jwt_secret?`: `string` ; `redis_url?`: `string` ; `store_cors?`: `string` } | | `projectConfig.admin_cors?` | `string` | @@ -44,7 +46,7 @@ ___ #### Defined in -medusa/dist/types/global.d.ts:38 +medusa/dist/types/global.d.ts:50 ___ @@ -81,3 +83,41 @@ ___ #### Defined in medusa/dist/types/global.d.ts:30 + +___ + +### ModuleDefinition + +Ƭ **ModuleDefinition**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `canOverride?` | `boolean` | +| `defaultPackage` | `string` | +| `isRequired?` | `boolean` | +| `key` | `string` | +| `label` | `string` | +| `registrationName` | `string` | + +#### Defined in + +medusa/dist/types/global.d.ts:42 + +___ + +### ModuleResolution + +Ƭ **ModuleResolution**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `definition` | [`ModuleDefinition`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduledefinition) | +| `resolutionPath` | `string` | + +#### Defined in + +medusa/dist/types/global.d.ts:38 diff --git a/docs/content/references/js-client/modules/internal.md b/docs/content/references/js-client/modules/internal.md index 12b544a806..b415ebea6a 100644 --- a/docs/content/references/js-client/modules/internal.md +++ b/docs/content/references/js-client/modules/internal.md @@ -129,7 +129,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/payment-collection.d.ts:16 +medusa/dist/models/payment-collection.d.ts:11 ## Type Aliases @@ -169,7 +169,7 @@ ___ #### Defined in -[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/request.ts#L21) +[medusa-js/src/request.ts:26](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/request.ts#L26) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L17) +[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L17) ___ @@ -201,7 +201,7 @@ ___ #### Defined in -[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/typings.ts#L21) +[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/typings.ts#L21) ___