asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Generated JS Client Reference (automated) (#2660)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and GitHub committed 2022-11-28 11:02:11 +02:00
1 parent 3cee0bc8fc
commit ee14155eb7
238 files changed
+2768 -1718
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/content/references/js-client/classes/AddressesResource.md
+3 -3
View File
@@ -27,7 +27,7 @@ Adds an address to a customers saved addresses
#### Defined in #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/Admin.md
+60 -30
View File
@@ -14,7 +14,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminAuthResource.md
+3 -3
View File
@@ -29,7 +29,7 @@ Creates an authenticated session
#### Defined in #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminBatchJobsResource.md
+5 -5
View File
@@ -25,7 +25,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminCollectionsResource.md
+7 -7
View File
@@ -30,7 +30,7 @@ Updates products associated with a Product Collection
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminCurrenciesResource.md
+2 -2
View File
@@ -33,7 +33,7 @@ the list of currencies as well as the pagination properties.
#### Defined in #### 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 #### 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)
docs/content/references/js-client/classes/AdminCustomerGroupsResource.md
+8 -8
View File
@@ -28,7 +28,7 @@ Add multiple customers to a customer group.
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminCustomersResource.md
+4 -4
View File
@@ -27,7 +27,7 @@ Creates a customer
#### Defined in #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminDiscountsResource.md
+16 -16
View File
@@ -32,7 +32,7 @@ Add a batch of items to a discount condition
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminDraftOrdersResource.md
+9 -9
View File
@@ -30,7 +30,7 @@ Add line item to draft order
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminGiftCardsResource.md
+5 -5
View File
@@ -29,7 +29,7 @@ Creates a gift card
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminInvitesResource.md
+5 -5
View File
@@ -25,7 +25,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminNotesResource.md
+5 -5
View File
@@ -25,7 +25,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminNotificationsResource.md
+2 -2
View File
@@ -25,7 +25,7 @@
#### Defined in #### 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 #### 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)
docs/content/references/js-client/classes/AdminOrderEditsResource.md
+12 -12
View File
@@ -26,7 +26,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminOrdersResource.md
+25 -25
View File
@@ -26,7 +26,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)
docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md
+93
View File
@@ -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)
docs/content/references/js-client/classes/AdminPaymentsResource.md
+72
View File
@@ -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)
docs/content/references/js-client/classes/AdminPriceListResource.md
+32 -32
View File
@@ -10,44 +10,44 @@
### addPrices ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-15.AdminPostPriceListPricesPricesReq.md) | | `payload` | [`AdminPostPriceListPricesPricesReq`](internal-17.AdminPostPriceListPricesPricesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostPriceListsPriceListReq`](internal-15.AdminPostPriceListsPriceListReq.md) | | `payload` | [`AdminPostPriceListsPriceListReq`](internal-17.AdminPostPriceListsPriceListReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-15.AdminDeletePriceListPricesPricesReq.md) | | `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-17.AdminDeletePriceListPricesPricesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -108,17 +108,17 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -130,32 +130,32 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetPriceListPaginationParams`](internal-15.AdminGetPriceListPaginationParams.md) | | `query?` | [`AdminGetPriceListPaginationParams`](internal-17.AdminGetPriceListPaginationParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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 | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-15.AdminGetPriceListsPriceListProductsParams.md) | | `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-17.AdminGetPriceListsPriceListProductsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### Returns
@@ -177,13 +177,13 @@ ___
#### Defined in #### 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
▸ **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 #### Parameters
@@ -194,30 +194,30 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-15.AdminPostPriceListsPriceListPriceListReq.md) | | `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-17.AdminPostPriceListsPriceListPriceListReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AdminProductTagsResource.md
+4 -4
View File
@@ -10,18 +10,18 @@
### list ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetProductTagsParams`](internal-16.AdminGetProductTagsParams.md) | | `query?` | [`AdminGetProductTagsParams`](internal-18.AdminGetProductTagsParams.md) |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AdminProductTypesResource.md
+4 -4
View File
@@ -10,19 +10,19 @@
### list ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetProductTypesParams`](internal-17.AdminGetProductTypesParams.md) | | `query?` | [`AdminGetProductTypesParams`](internal-19.AdminGetProductTypesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AdminProductsResource.md
+50 -50
View File
@@ -10,72 +10,72 @@
### addOption ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostProductsProductOptionsReq`](internal-18.AdminPostProductsProductOptionsReq.md) | | `payload` | [`AdminPostProductsProductOptionsReq`](internal-20.AdminPostProductsProductOptionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostProductsReq`](internal-18.AdminPostProductsReq.md) | | `payload` | [`AdminPostProductsReq`](internal-20.AdminPostProductsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostProductsProductVariantsReq`](internal-18.AdminPostProductsProductVariantsReq.md) | | `payload` | [`AdminPostProductsProductVariantsReq`](internal-20.AdminPostProductsProductVariantsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -86,17 +86,17 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -108,17 +108,17 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -130,38 +130,38 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetProductsParams`](internal-18.AdminGetProductsParams.md) | | `query?` | [`AdminGetProductsParams`](internal-20.AdminGetProductsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -171,17 +171,17 @@ ___
#### Returns #### 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 #### 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
▸ **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`** **`Deprecated`**
@@ -195,17 +195,17 @@ Use [list](AdminProductTypesResource.md#list) instead.
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -216,61 +216,61 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostProductsProductMetadataReq`](internal-18.AdminPostProductsProductMetadataReq.md) | | `payload` | [`AdminPostProductsProductMetadataReq`](internal-20.AdminPostProductsProductMetadataReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostProductsProductReq`](internal-18.AdminPostProductsProductReq.md) | | `payload` | [`AdminPostProductsProductReq`](internal-20.AdminPostProductsProductReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -278,22 +278,22 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `optionId` | `string` | | `optionId` | `string` |
| `payload` | [`AdminPostProductsProductOptionsOption`](internal-18.AdminPostProductsProductOptionsOption.md) | | `payload` | [`AdminPostProductsProductOptionsOption`](internal-20.AdminPostProductsProductOptionsOption.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -301,13 +301,13 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `variantId` | `string` | | `variantId` | `string` |
| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-18.AdminPostProductsProductVariantsVariantReq.md) | | `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-20.AdminPostProductsProductVariantsVariantReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md
+135
View File
@@ -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)
docs/content/references/js-client/classes/AdminRegionsResource.md
+40 -40
View File
@@ -10,7 +10,7 @@
### addCountry ### 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`** **`Description`**
@@ -21,24 +21,24 @@ adds a country to the list of countries in a region
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | region id | | `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-19.AdminPostRegionsRegionCountriesReq.md) | country data | | `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-22.AdminPostRegionsRegionCountriesReq.md) | country data |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region updated region
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -49,24 +49,24 @@ adds a fulfillment provider to a region
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | region id | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region updated region
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -77,24 +77,24 @@ adds a payment provider to a region
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | region id | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region updated region
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -104,18 +104,18 @@ creates a region.
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostRegionsReq`](internal-19.AdminPostRegionsReq.md) | | `payload` | [`AdminPostRegionsReq`](internal-22.AdminPostRegionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
created region. created region.
#### Defined in #### 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 #### 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
▸ **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`** **`Description`**
@@ -164,19 +164,19 @@ remove a country from a region's list of coutnries
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region updated region
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -192,19 +192,19 @@ remove a fulfillment provider from a region
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region updated region
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -220,19 +220,19 @@ removes a payment provider from a region
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region updated region
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -242,24 +242,24 @@ lists regions matching a query
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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. a list of regions matching the query.
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -274,19 +274,19 @@ get a region
#### Returns #### 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 the region with the given id
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -301,19 +301,19 @@ retrieves the list of fulfillment options available in a region
#### Returns #### 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 list of fulfillment options
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -324,15 +324,15 @@ updates a region
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the region to update. | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
the updated region. the updated region.
#### Defined in #### 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)
docs/content/references/js-client/classes/AdminReturnReasonsResource.md
+15 -15
View File
@@ -10,7 +10,7 @@
### create ### 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`** **`Description`**
@@ -20,18 +20,18 @@ Creates a return reason.
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostReturnReasonsReq`](internal-20.AdminPostReturnReasonsReq.md) | | `payload` | [`AdminPostReturnReasonsReq`](internal-23.AdminPostReturnReasonsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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. Created return reason.
#### Defined in #### 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 #### 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
▸ **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`** **`Description`**
@@ -78,19 +78,19 @@ Lists return reasons matching a query
#### Returns #### 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. a list of return reasons matching the query.
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -105,19 +105,19 @@ retrieves a return reason
#### Returns #### 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 the return reason with the given id
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -128,15 +128,15 @@ Updates a return reason
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the return reason to update. | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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. the updated return reason.
#### Defined in #### 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)
docs/content/references/js-client/classes/AdminReturnsResource.md
+11 -11
View File
@@ -10,7 +10,7 @@
### cancel ### 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`** **`Description`**
@@ -25,19 +25,19 @@ cancels a return
#### Returns #### 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 the order for which the return was canceled
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -47,24 +47,24 @@ lists returns matching a query
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 a list of returns matching the query
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -75,15 +75,15 @@ receive a return
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the return to receive. | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 the return
#### Defined in #### 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)
docs/content/references/js-client/classes/AdminSalesChannelsResource.md
+24 -24
View File
@@ -10,7 +10,7 @@
### addProducts ### 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 Add products to a sales channel
This feature is under development and may change in the future. This feature is under development and may change in the future.
@@ -25,39 +25,39 @@ Add products to a sales channel
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `salesChannelId` | `string` | | `salesChannelId` | `string` |
| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md) | | `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 a medusa sales channel
#### Defined in #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostSalesChannelsReq`](internal-22.AdminPostSalesChannelsReq.md) | | `payload` | [`AdminPostSalesChannelsReq`](internal-25.AdminPostSalesChannelsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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 #### 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
▸ **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 Retrieve a list of sales channels
This feature is under development and may change in the future. This feature is under development and may change in the future.
@@ -108,24 +108,24 @@ Retrieve a list of sales channels
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetSalesChannelsParams`](internal-22.AdminGetSalesChannelsParams.md) | | `query?` | [`AdminGetSalesChannelsParams`](internal-25.AdminGetSalesChannelsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 the list of sales channel as well as the pagination properties
#### Defined in #### 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
▸ **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 Remove products from a sales channel
This feature is under development and may change in the future. This feature is under development and may change in the future.
@@ -140,24 +140,24 @@ Remove products from a sales channel
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `salesChannelId` | `string` | | `salesChannelId` | `string` |
| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md) | | `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 a medusa sales channel
#### Defined in #### 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
▸ **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 retrieve a sales channel
This feature is under development and may change in the future. This feature is under development and may change in the future.
@@ -176,19 +176,19 @@ gets a sales channel
#### Returns #### 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 a medusa sales channel
#### Defined in #### 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
▸ **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 update a sales channel
This feature is under development and may change in the future. This feature is under development and may change in the future.
@@ -203,15 +203,15 @@ updates a sales channel
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `salesChannelId` | `string` | | `salesChannelId` | `string` |
| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-22.AdminPostSalesChannelsSalesChannelReq.md) | | `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-25.AdminPostSalesChannelsSalesChannelReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 the updated medusa sales channel
#### Defined in #### 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)
docs/content/references/js-client/classes/AdminShippingOptionsResource.md
+16 -16
View File
@@ -10,7 +10,7 @@
### create ### 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`** **`Description`**
@@ -20,18 +20,18 @@ creates a shipping option.
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostShippingOptionsReq`](internal-23.AdminPostShippingOptionsReq.md) | | `payload` | [`AdminPostShippingOptionsReq`](internal-26.AdminPostShippingOptionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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. created shipping option.
#### Defined in #### 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 #### 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
▸ **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`** **`Description`**
@@ -74,24 +74,24 @@ lists shipping options matching a query
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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. a list of shipping options matching the query.
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -106,19 +106,19 @@ get a shipping option
#### Returns #### 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 the shipping option with the given id
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -129,15 +129,15 @@ updates a shipping option
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the shipping option to update. | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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. the updated shipping option.
#### Defined in #### 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)
docs/content/references/js-client/classes/AdminShippingProfilesResource.md
+15 -15
View File
@@ -10,22 +10,22 @@
### create ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostShippingProfilesReq`](internal-24.AdminPostShippingProfilesReq.md) | | `payload` | [`AdminPostShippingProfilesReq`](internal-27.AdminPostShippingProfilesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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 #### 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
▸ **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 #### Parameters
@@ -62,17 +62,17 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -83,30 +83,30 @@ ___
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-24.AdminPostShippingProfilesProfileReq.md) | | `payload` | [`AdminPostShippingProfilesProfileReq`](internal-27.AdminPostShippingProfilesProfileReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AdminStoresResource.md
+19 -19
View File
@@ -10,7 +10,7 @@
### addCurrency ### 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`** **`Description`**
@@ -25,19 +25,19 @@ adds a currency to the store.
#### Returns #### 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. updated store.
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -52,19 +52,19 @@ deletes a currency from the available store currencies
#### Returns #### 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 updated store
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -78,19 +78,19 @@ Lists the store's payment providers
#### Returns #### 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 a list of payment providers configured on the store
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -104,19 +104,19 @@ Lists the store's payment providers
#### Returns #### 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 a list of payment providers configured on the store
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -130,19 +130,19 @@ gets a medusa store
#### Returns #### 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 a medusa store
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -152,15 +152,15 @@ Updates the store
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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. the updated store.
#### Defined in #### 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)
docs/content/references/js-client/classes/AdminSwapsResource.md
+7 -7
View File
@@ -10,28 +10,28 @@
### list ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetSwapsParams`](internal-26.AdminGetSwapsParams.md) | | `query?` | [`AdminGetSwapsParams`](internal-29.AdminGetSwapsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
@@ -42,8 +42,8 @@ ___
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AdminTaxRatesResource.md
+49 -49
View File
@@ -10,92 +10,92 @@
### addProductTypes ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md) | | `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-27.AdminPostTaxRatesTaxRateProductsReq.md) | | `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-30.AdminPostTaxRatesTaxRateProductsReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | | `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostTaxRatesReq`](internal-27.AdminPostTaxRatesReq.md) | | `payload` | [`AdminPostTaxRatesReq`](internal-30.AdminPostTaxRatesReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetTaxRatesParams`](internal-27.AdminGetTaxRatesParams.md) | | `query?` | [`AdminGetTaxRatesParams`](internal-30.AdminGetTaxRatesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | | `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | | `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md) | | `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md) | | `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | | `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | | `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-27.AdminPostTaxRatesTaxRateReq.md) | | `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-30.AdminPostTaxRatesTaxRateReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-27.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AdminUploadsResource.md
+15 -15
View File
@@ -20,47 +20,47 @@
#### Defined in #### 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 ## Methods
### create ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `file` | [`IAdminPostUploadsFileReq`](internal-28.IAdminPostUploadsFileReq.md) | | `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) |
#### Returns #### 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 #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `file` | [`IAdminPostUploadsFileReq`](internal-28.IAdminPostUploadsFileReq.md) | | `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) |
#### Returns #### 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 #### 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 | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminDeleteUploadsReq`](internal-28.AdminDeleteUploadsReq.md) | | `payload` | [`AdminDeleteUploadsReq`](internal-31.AdminDeleteUploadsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### Returns
@@ -81,25 +81,25 @@ ___
#### Defined in #### 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
▸ **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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-28.AdminPostUploadsDownloadUrlReq.md) | | `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-31.AdminPostUploadsDownloadUrlReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AdminUsersResource.md
+21 -21
View File
@@ -10,7 +10,7 @@
### create ### 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`** **`Description`**
@@ -20,18 +20,18 @@ creates a user with the provided information
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 created user
#### Defined in #### 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 #### 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
▸ **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`** **`Description`**
@@ -78,19 +78,19 @@ lists all users
#### Returns #### 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 a list of all users
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -100,22 +100,22 @@ resets the users password given the correct token.
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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 Retrieves a given user
@@ -128,13 +128,13 @@ Retrieves a given user
#### Returns #### 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 the user
#### Defined in #### 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 | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
@@ -159,13 +159,13 @@ resets password by re-sending password token.
#### Defined in #### 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
▸ **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`** **`Description`**
@@ -176,15 +176,15 @@ updates a given user
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the user to update | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 the updated user
#### Defined in #### 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)
docs/content/references/js-client/classes/AdminVariantsResource.md
+4 -4
View File
@@ -10,19 +10,19 @@
### list ### 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 #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetVariantsParams`](internal-30.AdminGetVariantsParams.md) | | `query?` | [`AdminGetVariantsParams`](internal-33.AdminGetVariantsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/AuthResource.md
+11 -11
View File
@@ -10,7 +10,7 @@
### authenticate ### 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`** **`Description`**
@@ -20,16 +20,16 @@ Authenticates a customer using email and password combination
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`StorePostAuthReq`](internal-31.StorePostAuthReq.md) | authentication payload | | `payload` | [`StorePostAuthReq`](internal-34.StorePostAuthReq.md) | authentication payload |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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 #### 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
▸ **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`** **`Description`**
@@ -74,17 +74,17 @@ Check if email exists
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -99,8 +99,8 @@ Usually used to check if authenticated session is alive.
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/CartsResource.md
+39 -39
View File
@@ -14,13 +14,13 @@
#### Defined in #### 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 ## Methods
### addShippingMethod ### 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 Adds a shipping method to cart
@@ -29,22 +29,22 @@ Adds a shipping method to cart
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | Id of cart | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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. Completes a cart.
Payment authorization is attempted and if more work is required, we simply return the cart for further updates. 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 #### 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 #### 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
▸ **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 Creates a cart
@@ -79,22 +79,22 @@ Creates a cart
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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. Creates payment sessions.
Initializes the payment sessions that can be used to pay for the items of the cart. 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 #### 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 #### 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
▸ **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. Removes a discount from cart.
@@ -133,17 +133,17 @@ Removes a discount from cart.
#### Returns #### 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 #### 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
▸ **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. Removes a payment session from a cart.
Can be useful in case a payment has failed Can be useful in case a payment has failed
@@ -158,17 +158,17 @@ Can be useful in case a payment has failed
#### Returns #### 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 #### 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
▸ **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. Refreshes a payment session.
@@ -182,17 +182,17 @@ Refreshes a payment session.
#### Returns #### 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 #### 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
▸ **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 Retrieves a cart
@@ -205,17 +205,17 @@ Retrieves a cart
#### Returns #### 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 #### 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
▸ **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. Refreshes a payment session.
@@ -224,22 +224,22 @@ Refreshes a payment session.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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 Updates a cart
@@ -248,22 +248,22 @@ Updates a cart
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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 Updates the payment method
@@ -273,13 +273,13 @@ Updates the payment method
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `provider_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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/CollectionsResource.md
+7 -7
View File
@@ -10,7 +10,7 @@
### list ### 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`** **`Description`**
@@ -20,22 +20,22 @@ Retrieves a list of collections
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -50,8 +50,8 @@ Retrieves a single collection
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/CustomerResource.md
+15 -15
View File
@@ -14,7 +14,7 @@
#### Defined in #### 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 #### 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 ## Methods
@@ -38,7 +38,7 @@ Creates a customer
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
@@ -47,7 +47,7 @@ Creates a customer
#### Defined in #### 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 | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
@@ -71,13 +71,13 @@ The token is not returned but should be sent out to the customer in an email.
#### Defined in #### 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
▸ **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 Retrieve customer orders
@@ -85,16 +85,16 @@ Retrieve customer orders
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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 | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
@@ -117,7 +117,7 @@ Resets customer password
#### Defined in #### 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 #### 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 | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### Returns
@@ -162,4 +162,4 @@ Updates a customer
#### Defined in #### 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)
docs/content/references/js-client/classes/GiftCardsResource.md
+3 -3
View File
@@ -10,7 +10,7 @@
### retrieve ### 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`** **`Description`**
@@ -25,8 +25,8 @@ Retrieves a single GiftCard
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/LineItemsResource.md
+11 -11
View File
@@ -10,7 +10,7 @@
### create ### 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 Creates a line-item for a cart
@@ -19,22 +19,22 @@ Creates a line-item for a cart
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | id of cart | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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 Remove a line-item from a cart
@@ -48,17 +48,17 @@ Remove a line-item from a cart
#### Returns #### 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 #### 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
▸ **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. Updates a line-item.
Only quantity updates are allowed Only quantity updates are allowed
@@ -69,13 +69,13 @@ Only quantity updates are allowed
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | id of cart | | `cart_id` | `string` | id of cart |
| `line_id` | `string` | id of item to update | | `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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/OrderEditsResource.md
+6 -6
View File
@@ -25,7 +25,7 @@
#### Defined in #### 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 | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-37.StorePostOrderEditsOrderEditDecline.md) | | `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-40.StorePostOrderEditsOrderEditDecline.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### Returns
@@ -47,13 +47,13 @@ ___
#### Defined in #### 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
▸ **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 #### Parameters
@@ -64,8 +64,8 @@ ___
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/OrdersResource.md
+10 -10
View File
@@ -10,7 +10,7 @@
### lookupOrder ### 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`** **`Description`**
@@ -20,22 +20,22 @@ Look up an order using order details
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -50,17 +50,17 @@ Retrieves an order
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -75,8 +75,8 @@ Retrieves an order by cart id
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/PaymentCollectionsResource.md
+95
View File
@@ -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)
docs/content/references/js-client/classes/PaymentMethodsResource.md
+3 -3
View File
@@ -10,7 +10,7 @@
### list ### 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 Lists customer payment methods
@@ -22,8 +22,8 @@ Lists customer payment methods
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/ProductTypesResource.md
+4 -4
View File
@@ -10,7 +10,7 @@
### list ### 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`** **`Description`**
@@ -20,13 +20,13 @@ Retrieves a list of product types
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/ProductVariantsResource.md
+7 -7
View File
@@ -10,7 +10,7 @@
### list ### 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`** **`Description`**
@@ -20,22 +20,22 @@ Retrieves a list of of Product Variants
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`StoreGetVariantsParams`](internal-41.StoreGetVariantsParams.md) | | `query?` | [`StoreGetVariantsParams`](internal-45.StoreGetVariantsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -50,8 +50,8 @@ Retrieves a single product variant
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/ProductsResource.md
+12 -12
View File
@@ -14,13 +14,13 @@
#### Defined in #### 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 ## Methods
### list ### 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`** **`Description`**
@@ -30,22 +30,22 @@ Retrieves a list of products
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -60,17 +60,17 @@ Retrieves a single Product
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -80,13 +80,13 @@ Searches for products
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `searchOptions` | [`StorePostSearchReq`](internal-42.StorePostSearchReq.md) | is required | | `searchOptions` | [`StorePostSearchReq`](internal-46.StorePostSearchReq.md) | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/RegionsResource.md
+6 -6
View File
@@ -10,7 +10,7 @@
### list ### 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`** **`Description`**
@@ -24,17 +24,17 @@ Retrieves a list of regions
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -49,8 +49,8 @@ Retrieves a region
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/ReturnReasonsResource.md
+6 -6
View File
@@ -10,7 +10,7 @@
### list ### 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 Lists return reasons defined in Medusa Admin
@@ -22,17 +22,17 @@ Lists return reasons defined in Medusa Admin
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -47,8 +47,8 @@ Retrieves a single Return Reason
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/ReturnsResource.md
+4 -4
View File
@@ -10,7 +10,7 @@
### create ### 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 Creates a return request
@@ -18,13 +18,13 @@ Creates a return request
| Name | Type | Description | | 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`\> | | | `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/ShippingOptionsResource.md
+7 -7
View File
@@ -10,7 +10,7 @@
### list ### 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`** **`Description`**
@@ -20,22 +20,22 @@ Lists shiping options available
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`StoreGetShippingOptionsParams`](internal-46.StoreGetShippingOptionsParams.md) | | `query?` | [`StoreGetShippingOptionsParams`](internal-50.StoreGetShippingOptionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -50,8 +50,8 @@ Lists shiping options available for a cart
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/SwapsResource.md
+7 -7
View File
@@ -10,7 +10,7 @@
### create ### 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`** **`Description`**
@@ -20,22 +20,22 @@ Creates a swap from a cart
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`StorePostSwapsReq`](internal-47.StorePostSwapsReq.md) | | `payload` | [`StorePostSwapsReq`](internal-51.StorePostSwapsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | `Record`<`string`, `any`\> |
#### Returns #### 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 #### 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
▸ **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`** **`Description`**
@@ -50,8 +50,8 @@ Retrieves a swap by cart id
#### Returns #### 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 #### 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)
docs/content/references/js-client/classes/internal-15.AdminUpdatePaymentCollectionRequest.md
+23
View File
@@ -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
docs/content/references/js-client/classes/internal-15.GetPaymentCollectionsParams.md
+37
View File
@@ -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
docs/content/references/js-client/classes/internal-16.AdminPostPaymentRefundsReq.md
+33
View File
@@ -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
docs/content/references/js-client/classes/internal-16.GetPaymentsParams.md
+37
View File
@@ -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
docs/content/references/js-client/classes/internal-15.AdminDeletePriceListPricesPricesReq.md → docs/content/references/js-client/classes/internal-17.AdminDeletePriceListPricesPricesReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: AdminDeletePriceListPricesPricesReq # Class: AdminDeletePriceListPricesPricesReq
[internal](../modules/internal-15.md).AdminDeletePriceListPricesPricesReq [internal](../modules/internal-17.md).AdminDeletePriceListPricesPricesReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-15.AdminGetPriceListPaginationParams.md → docs/content/references/js-client/classes/internal-17.AdminGetPriceListPaginationParams.md
+12 -12
View File
@@ -1,10 +1,10 @@
# Class: AdminGetPriceListPaginationParams # Class: AdminGetPriceListPaginationParams
[internal](../modules/internal-15.md).AdminGetPriceListPaginationParams [internal](../modules/internal-17.md).AdminGetPriceListPaginationParams
## Hierarchy ## Hierarchy
- [`FilterablePriceListProps`](internal-15.FilterablePriceListProps.md) - [`FilterablePriceListProps`](internal-17.FilterablePriceListProps.md)
↳ **`AdminGetPriceListPaginationParams`** ↳ **`AdminGetPriceListPaginationParams`**
@@ -16,7 +16,7 @@
#### Inherited from #### 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 #### Defined in
@@ -30,7 +30,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -44,7 +44,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -58,7 +58,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -82,7 +82,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -106,7 +106,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -140,7 +140,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -154,7 +154,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -168,7 +168,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -182,7 +182,7 @@ ___
#### Inherited from #### 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 #### Defined in
docs/content/references/js-client/classes/internal-15.AdminGetPriceListsPriceListProductsParams.md → docs/content/references/js-client/classes/internal-17.AdminGetPriceListsPriceListProductsParams.md
+2 -2
View File
@@ -1,10 +1,10 @@
# Class: AdminGetPriceListsPriceListProductsParams # Class: AdminGetPriceListsPriceListProductsParams
[internal](../modules/internal-15.md).AdminGetPriceListsPriceListProductsParams [internal](../modules/internal-17.md).AdminGetPriceListsPriceListProductsParams
## Hierarchy ## Hierarchy
- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-15.md#admingetpricelistspricelistproductsparams_base) - [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-17.md#admingetpricelistspricelistproductsparams_base)
↳ **`AdminGetPriceListsPriceListProductsParams`** ↳ **`AdminGetPriceListsPriceListProductsParams`**
docs/content/references/js-client/classes/internal-15.AdminPostPriceListPricesPricesReq.md → docs/content/references/js-client/classes/internal-17.AdminPostPriceListPricesPricesReq.md
+2 -2
View File
@@ -1,6 +1,6 @@
# Class: AdminPostPriceListPricesPricesReq # Class: AdminPostPriceListPricesPricesReq
[internal](../modules/internal-15.md).AdminPostPriceListPricesPricesReq [internal](../modules/internal-17.md).AdminPostPriceListPricesPricesReq
## Properties ## Properties
@@ -16,7 +16,7 @@ ___
### prices ### prices
• **prices**: [`AdminPriceListPricesUpdateReq`](internal-15.AdminPriceListPricesUpdateReq.md)[] • **prices**: [`AdminPriceListPricesUpdateReq`](internal-17.AdminPriceListPricesUpdateReq.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md → docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md
+3 -3
View File
@@ -1,12 +1,12 @@
# Class: AdminPostPriceListsPriceListPriceListReq # Class: AdminPostPriceListsPriceListPriceListReq
[internal](../modules/internal-15.md).AdminPostPriceListsPriceListPriceListReq [internal](../modules/internal-17.md).AdminPostPriceListsPriceListPriceListReq
## Properties ## Properties
### customer\_groups ### customer\_groups
• `Optional` **customer\_groups**: [`CustomerGroup`](internal-15.CustomerGroup-1.md)[] • `Optional` **customer\_groups**: [`CustomerGroup`](internal-17.CustomerGroup-1.md)[]
#### Defined in #### Defined in
@@ -56,7 +56,7 @@ ___
### prices ### prices
• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-15.AdminPriceListPricesUpdateReq.md)[] • `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-17.AdminPriceListPricesUpdateReq.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-15.AdminPostPriceListsPriceListReq.md → docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListReq.md
+3 -3
View File
@@ -1,12 +1,12 @@
# Class: AdminPostPriceListsPriceListReq # Class: AdminPostPriceListsPriceListReq
[internal](../modules/internal-15.md).AdminPostPriceListsPriceListReq [internal](../modules/internal-17.md).AdminPostPriceListsPriceListReq
## Properties ## Properties
### customer\_groups ### customer\_groups
• `Optional` **customer\_groups**: [`CustomerGroup`](internal-15.CustomerGroup.md)[] • `Optional` **customer\_groups**: [`CustomerGroup`](internal-17.CustomerGroup.md)[]
#### Defined in #### Defined in
@@ -56,7 +56,7 @@ ___
### prices ### prices
• **prices**: [`AdminPriceListPricesCreateReq`](internal-15.AdminPriceListPricesCreateReq.md)[] • **prices**: [`AdminPriceListPricesCreateReq`](internal-17.AdminPriceListPricesCreateReq.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-15.AdminPriceListPricesCreateReq.md → docs/content/references/js-client/classes/internal-17.AdminPriceListPricesCreateReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: AdminPriceListPricesCreateReq # Class: AdminPriceListPricesCreateReq
[internal](../modules/internal-15.md).AdminPriceListPricesCreateReq [internal](../modules/internal-17.md).AdminPriceListPricesCreateReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-15.AdminPriceListPricesUpdateReq.md → docs/content/references/js-client/classes/internal-17.AdminPriceListPricesUpdateReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: AdminPriceListPricesUpdateReq # Class: AdminPriceListPricesUpdateReq
[internal](../modules/internal-15.md).AdminPriceListPricesUpdateReq [internal](../modules/internal-17.md).AdminPriceListPricesUpdateReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-15.CustomerGroup-1.md → docs/content/references/js-client/classes/internal-17.CustomerGroup-1.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: CustomerGroup # Class: CustomerGroup
[internal](../modules/internal-15.md).CustomerGroup [internal](../modules/internal-17.md).CustomerGroup
## Properties ## Properties
docs/content/references/js-client/classes/internal-15.CustomerGroup.md → docs/content/references/js-client/classes/internal-17.CustomerGroup.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: CustomerGroup # Class: CustomerGroup
[internal](../modules/internal-15.md).CustomerGroup [internal](../modules/internal-17.md).CustomerGroup
## Properties ## Properties
docs/content/references/js-client/classes/internal-15.FilterablePriceListProps.md → docs/content/references/js-client/classes/internal-17.FilterablePriceListProps.md
+2 -2
View File
@@ -1,12 +1,12 @@
# Class: FilterablePriceListProps # Class: FilterablePriceListProps
[internal](../modules/internal-15.md).FilterablePriceListProps [internal](../modules/internal-17.md).FilterablePriceListProps
## Hierarchy ## Hierarchy
- **`FilterablePriceListProps`** - **`FilterablePriceListProps`**
↳ [`AdminGetPriceListPaginationParams`](internal-15.AdminGetPriceListPaginationParams.md) ↳ [`AdminGetPriceListPaginationParams`](internal-17.AdminGetPriceListPaginationParams.md)
## Properties ## Properties
docs/content/references/js-client/classes/internal-16.AdminGetProductTagsPaginationParams.md → docs/content/references/js-client/classes/internal-18.AdminGetProductTagsPaginationParams.md
+2 -2
View File
@@ -1,12 +1,12 @@
# Class: AdminGetProductTagsPaginationParams # Class: AdminGetProductTagsPaginationParams
[internal](../modules/internal-16.md).AdminGetProductTagsPaginationParams [internal](../modules/internal-18.md).AdminGetProductTagsPaginationParams
## Hierarchy ## Hierarchy
- **`AdminGetProductTagsPaginationParams`** - **`AdminGetProductTagsPaginationParams`**
↳ [`AdminGetProductTagsParams`](internal-16.AdminGetProductTagsParams.md) ↳ [`AdminGetProductTagsParams`](internal-18.AdminGetProductTagsParams.md)
## Properties ## Properties
docs/content/references/js-client/classes/internal-16.AdminGetProductTagsParams.md → docs/content/references/js-client/classes/internal-18.AdminGetProductTagsParams.md
+4 -4
View File
@@ -1,10 +1,10 @@
# Class: AdminGetProductTagsParams # Class: AdminGetProductTagsParams
[internal](../modules/internal-16.md).AdminGetProductTagsParams [internal](../modules/internal-18.md).AdminGetProductTagsParams
## Hierarchy ## Hierarchy
- [`AdminGetProductTagsPaginationParams`](internal-16.AdminGetProductTagsPaginationParams.md) - [`AdminGetProductTagsPaginationParams`](internal-18.AdminGetProductTagsPaginationParams.md)
↳ **`AdminGetProductTagsParams`** ↳ **`AdminGetProductTagsParams`**
@@ -46,7 +46,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -60,7 +60,7 @@ ___
#### Inherited from #### 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 #### Defined in
docs/content/references/js-client/classes/internal-17.AdminGetProductTypesParams.md → docs/content/references/js-client/classes/internal-19.AdminGetProductTypesParams.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: AdminGetProductTypesParams # Class: AdminGetProductTypesParams
[internal](../modules/internal-17.md).AdminGetProductTypesParams [internal](../modules/internal-19.md).AdminGetProductTypesParams
## Hierarchy ## Hierarchy
docs/content/references/js-client/classes/internal-18.AdminGetProductsParams.md → docs/content/references/js-client/classes/internal-20.AdminGetProductsParams.md
+18 -18
View File
@@ -1,12 +1,12 @@
# Class: AdminGetProductsParams # Class: AdminGetProductsParams
[internal](../modules/internal-18.md).AdminGetProductsParams [internal](../modules/internal-20.md).AdminGetProductsParams
API Level DTOs + Validation rules API Level DTOs + Validation rules
## Hierarchy ## Hierarchy
- [`FilterableProductProps`](internal-18.FilterableProductProps.md) - [`FilterableProductProps`](internal-20.FilterableProductProps.md)
↳ **`AdminGetProductsParams`** ↳ **`AdminGetProductsParams`**
@@ -18,7 +18,7 @@ API Level DTOs + Validation rules
#### Inherited from #### 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 #### Defined in
@@ -32,7 +32,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -46,7 +46,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -60,7 +60,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -74,7 +74,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -108,7 +108,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -122,7 +122,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -136,7 +136,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -170,7 +170,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -184,7 +184,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -198,7 +198,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -212,7 +212,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -226,7 +226,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -240,7 +240,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -254,7 +254,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -268,7 +268,7 @@ ___
#### Inherited from #### 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 #### Defined in
docs/content/references/js-client/classes/internal-18.AdminPostProductsProductMetadataReq.md → docs/content/references/js-client/classes/internal-20.AdminPostProductsProductMetadataReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: AdminPostProductsProductMetadataReq # Class: AdminPostProductsProductMetadataReq
[internal](../modules/internal-18.md).AdminPostProductsProductMetadataReq [internal](../modules/internal-20.md).AdminPostProductsProductMetadataReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsOption.md → docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsOption.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: AdminPostProductsProductOptionsOption # Class: AdminPostProductsProductOptionsOption
[internal](../modules/internal-18.md).AdminPostProductsProductOptionsOption [internal](../modules/internal-20.md).AdminPostProductsProductOptionsOption
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.AdminPostProductsProductOptionsReq.md → docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: AdminPostProductsProductOptionsReq # Class: AdminPostProductsProductOptionsReq
[internal](../modules/internal-18.md).AdminPostProductsProductOptionsReq [internal](../modules/internal-20.md).AdminPostProductsProductOptionsReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.AdminPostProductsProductReq.md → docs/content/references/js-client/classes/internal-20.AdminPostProductsProductReq.md
+5 -5
View File
@@ -1,6 +1,6 @@
# Class: AdminPostProductsProductReq # Class: AdminPostProductsProductReq
[internal](../modules/internal-18.md).AdminPostProductsProductReq [internal](../modules/internal-20.md).AdminPostProductsProductReq
## Properties ## Properties
@@ -126,7 +126,7 @@ ___
### sales\_channels ### sales\_channels
• **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-18.ProductSalesChannelReq.md)[] • **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-20.ProductSalesChannelReq.md)[]
#### Defined in #### Defined in
@@ -156,7 +156,7 @@ ___
### tags ### tags
• `Optional` **tags**: [`ProductTagReq`](internal-18.ProductTagReq.md)[] • `Optional` **tags**: [`ProductTagReq`](internal-20.ProductTagReq.md)[]
#### Defined in #### Defined in
@@ -186,7 +186,7 @@ ___
### type ### type
• `Optional` **type**: [`ProductTypeReq`](internal-18.ProductTypeReq.md) • `Optional` **type**: [`ProductTypeReq`](internal-20.ProductTypeReq.md)
#### Defined in #### Defined in
@@ -196,7 +196,7 @@ ___
### variants ### variants
• `Optional` **variants**: [`ProductVariantReq`](internal-18.ProductVariantReq-1.md)[] • `Optional` **variants**: [`ProductVariantReq`](internal-20.ProductVariantReq-1.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsReq.md → docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsReq.md
+3 -3
View File
@@ -1,6 +1,6 @@
# Class: AdminPostProductsProductVariantsReq # Class: AdminPostProductsProductVariantsReq
[internal](../modules/internal-18.md).AdminPostProductsProductVariantsReq [internal](../modules/internal-20.md).AdminPostProductsProductVariantsReq
## Properties ## Properties
@@ -116,7 +116,7 @@ ___
### options ### options
• **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq.md)[] • **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq.md)[]
#### Defined in #### Defined in
@@ -136,7 +136,7 @@ ___
### prices ### prices
• **prices**: [`ProductVariantPricesCreateReq`](internal-18.ProductVariantPricesCreateReq.md)[] • **prices**: [`ProductVariantPricesCreateReq`](internal-20.ProductVariantPricesCreateReq.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-18.AdminPostProductsProductVariantsVariantReq.md → docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsVariantReq.md
+3 -3
View File
@@ -1,6 +1,6 @@
# Class: AdminPostProductsProductVariantsVariantReq # Class: AdminPostProductsProductVariantsVariantReq
[internal](../modules/internal-18.md).AdminPostProductsProductVariantsVariantReq [internal](../modules/internal-20.md).AdminPostProductsProductVariantsVariantReq
## Properties ## Properties
@@ -116,7 +116,7 @@ ___
### options ### options
• **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-1.md)[] • **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-1.md)[]
#### Defined in #### Defined in
@@ -136,7 +136,7 @@ ___
### prices ### prices
• **prices**: [`ProductVariantPricesUpdateReq`](internal-18.ProductVariantPricesUpdateReq.md)[] • **prices**: [`ProductVariantPricesUpdateReq`](internal-20.ProductVariantPricesUpdateReq.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-18.AdminPostProductsReq.md → docs/content/references/js-client/classes/internal-20.AdminPostProductsReq.md
+6 -6
View File
@@ -1,6 +1,6 @@
# Class: AdminPostProductsReq # Class: AdminPostProductsReq
[internal](../modules/internal-18.md).AdminPostProductsReq [internal](../modules/internal-20.md).AdminPostProductsReq
## Properties ## Properties
@@ -126,7 +126,7 @@ ___
### options ### options
• `Optional` **options**: [`ProductOptionReq`](internal-18.ProductOptionReq.md)[] • `Optional` **options**: [`ProductOptionReq`](internal-20.ProductOptionReq.md)[]
#### Defined in #### Defined in
@@ -146,7 +146,7 @@ ___
### sales\_channels ### sales\_channels
• `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-18.ProductSalesChannelReq.md)[] • `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-20.ProductSalesChannelReq.md)[]
#### Defined in #### Defined in
@@ -176,7 +176,7 @@ ___
### tags ### tags
• `Optional` **tags**: [`ProductTagReq`](internal-18.ProductTagReq.md)[] • `Optional` **tags**: [`ProductTagReq`](internal-20.ProductTagReq.md)[]
#### Defined in #### Defined in
@@ -206,7 +206,7 @@ ___
### type ### type
• `Optional` **type**: [`ProductTypeReq`](internal-18.ProductTypeReq.md) • `Optional` **type**: [`ProductTypeReq`](internal-20.ProductTypeReq.md)
#### Defined in #### Defined in
@@ -216,7 +216,7 @@ ___
### variants ### variants
• `Optional` **variants**: [`ProductVariantReq`](internal-18.ProductVariantReq.md)[] • `Optional` **variants**: [`ProductVariantReq`](internal-20.ProductVariantReq.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-18.FilterableProductProps.md → docs/content/references/js-client/classes/internal-20.FilterableProductProps.md
+2 -2
View File
@@ -1,6 +1,6 @@
# Class: FilterableProductProps # Class: FilterableProductProps
[internal](../modules/internal-18.md).FilterableProductProps [internal](../modules/internal-20.md).FilterableProductProps
API Level DTOs + Validation rules API Level DTOs + Validation rules
@@ -8,7 +8,7 @@ API Level DTOs + Validation rules
- **`FilterableProductProps`** - **`FilterableProductProps`**
↳ [`AdminGetProductsParams`](internal-18.AdminGetProductsParams.md) ↳ [`AdminGetProductsParams`](internal-20.AdminGetProductsParams.md)
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductOptionReq.md → docs/content/references/js-client/classes/internal-20.ProductOptionReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductOptionReq # Class: ProductOptionReq
[internal](../modules/internal-18.md).ProductOptionReq [internal](../modules/internal-20.md).ProductOptionReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductSalesChannelReq.md → docs/content/references/js-client/classes/internal-20.ProductSalesChannelReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductSalesChannelReq # Class: ProductSalesChannelReq
[internal](../modules/internal-18.md).ProductSalesChannelReq [internal](../modules/internal-20.md).ProductSalesChannelReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductTagReq.md → docs/content/references/js-client/classes/internal-20.ProductTagReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductTagReq # Class: ProductTagReq
[internal](../modules/internal-18.md).ProductTagReq [internal](../modules/internal-20.md).ProductTagReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductTypeReq.md → docs/content/references/js-client/classes/internal-20.ProductTypeReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductTypeReq # Class: ProductTypeReq
[internal](../modules/internal-18.md).ProductTypeReq [internal](../modules/internal-20.md).ProductTypeReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-1.md → docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-1.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductVariantOptionReq # Class: ProductVariantOptionReq
[internal](../modules/internal-18.md).ProductVariantOptionReq [internal](../modules/internal-20.md).ProductVariantOptionReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-2.md → docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-2.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductVariantOptionReq # Class: ProductVariantOptionReq
[internal](../modules/internal-18.md).ProductVariantOptionReq [internal](../modules/internal-20.md).ProductVariantOptionReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq-3.md → docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-3.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductVariantOptionReq # Class: ProductVariantOptionReq
[internal](../modules/internal-18.md).ProductVariantOptionReq [internal](../modules/internal-20.md).ProductVariantOptionReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductVariantOptionReq.md → docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductVariantOptionReq # Class: ProductVariantOptionReq
[internal](../modules/internal-18.md).ProductVariantOptionReq [internal](../modules/internal-20.md).ProductVariantOptionReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductVariantPricesCreateReq.md → docs/content/references/js-client/classes/internal-20.ProductVariantPricesCreateReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductVariantPricesCreateReq # Class: ProductVariantPricesCreateReq
[internal](../modules/internal-18.md).ProductVariantPricesCreateReq [internal](../modules/internal-20.md).ProductVariantPricesCreateReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductVariantPricesUpdateReq.md → docs/content/references/js-client/classes/internal-20.ProductVariantPricesUpdateReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: ProductVariantPricesUpdateReq # Class: ProductVariantPricesUpdateReq
[internal](../modules/internal-18.md).ProductVariantPricesUpdateReq [internal](../modules/internal-20.md).ProductVariantPricesUpdateReq
## Properties ## Properties
docs/content/references/js-client/classes/internal-18.ProductVariantReq-1.md → docs/content/references/js-client/classes/internal-20.ProductVariantReq-1.md
+3 -3
View File
@@ -1,6 +1,6 @@
# Class: ProductVariantReq # Class: ProductVariantReq
[internal](../modules/internal-18.md).ProductVariantReq [internal](../modules/internal-20.md).ProductVariantReq
## Properties ## Properties
@@ -126,7 +126,7 @@ ___
### options ### options
• `Optional` **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-3.md)[] • `Optional` **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-3.md)[]
#### Defined in #### Defined in
@@ -146,7 +146,7 @@ ___
### prices ### prices
• **prices**: [`ProductVariantPricesUpdateReq`](internal-18.ProductVariantPricesUpdateReq.md)[] • **prices**: [`ProductVariantPricesUpdateReq`](internal-20.ProductVariantPricesUpdateReq.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-18.ProductVariantReq.md → docs/content/references/js-client/classes/internal-20.ProductVariantReq.md
+3 -3
View File
@@ -1,6 +1,6 @@
# Class: ProductVariantReq # Class: ProductVariantReq
[internal](../modules/internal-18.md).ProductVariantReq [internal](../modules/internal-20.md).ProductVariantReq
## Properties ## Properties
@@ -116,7 +116,7 @@ ___
### options ### options
• `Optional` **options**: [`ProductVariantOptionReq`](internal-18.ProductVariantOptionReq-2.md)[] • `Optional` **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-2.md)[]
#### Defined in #### Defined in
@@ -136,7 +136,7 @@ ___
### prices ### prices
• **prices**: [`ProductVariantPricesCreateReq`](internal-18.ProductVariantPricesCreateReq.md)[] • **prices**: [`ProductVariantPricesCreateReq`](internal-20.ProductVariantPricesCreateReq.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md
+13
View File
@@ -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
docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysReq.md
+13
View File
@@ -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
docs/content/references/js-client/classes/internal-21.GetPublishableApiKeysParams.md
+75
View File
@@ -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
docs/content/references/js-client/classes/internal-21.PublishableApiKey.md
+103
View File
@@ -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
docs/content/references/js-client/classes/internal-19.AdminGetRegionsPaginationParams.md → docs/content/references/js-client/classes/internal-22.AdminGetRegionsPaginationParams.md
+2 -2
View File
@@ -1,12 +1,12 @@
# Class: AdminGetRegionsPaginationParams # Class: AdminGetRegionsPaginationParams
[internal](../modules/internal-19.md).AdminGetRegionsPaginationParams [internal](../modules/internal-22.md).AdminGetRegionsPaginationParams
## Hierarchy ## Hierarchy
- **`AdminGetRegionsPaginationParams`** - **`AdminGetRegionsPaginationParams`**
↳ [`AdminGetRegionsParams`](internal-19.AdminGetRegionsParams.md) ↳ [`AdminGetRegionsParams`](internal-22.AdminGetRegionsParams.md)
## Properties ## Properties
docs/content/references/js-client/classes/internal-19.AdminGetRegionsParams.md → docs/content/references/js-client/classes/internal-22.AdminGetRegionsParams.md
+4 -4
View File
@@ -1,10 +1,10 @@
# Class: AdminGetRegionsParams # Class: AdminGetRegionsParams
[internal](../modules/internal-19.md).AdminGetRegionsParams [internal](../modules/internal-22.md).AdminGetRegionsParams
## Hierarchy ## Hierarchy
- [`AdminGetRegionsPaginationParams`](internal-19.AdminGetRegionsPaginationParams.md) - [`AdminGetRegionsPaginationParams`](internal-22.AdminGetRegionsPaginationParams.md)
↳ **`AdminGetRegionsParams`** ↳ **`AdminGetRegionsParams`**
@@ -36,7 +36,7 @@ ___
#### Inherited from #### 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 #### Defined in
@@ -50,7 +50,7 @@ ___
#### Inherited from #### 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 #### Defined in
docs/content/references/js-client/classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md → docs/content/references/js-client/classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md
+2 -2
View File
@@ -1,12 +1,12 @@
# Class: AdminGetRegionsRegionFulfillmentOptionsRes # Class: AdminGetRegionsRegionFulfillmentOptionsRes
[internal](../modules/internal-19.md).AdminGetRegionsRegionFulfillmentOptionsRes [internal](../modules/internal-22.md).AdminGetRegionsRegionFulfillmentOptionsRes
## Properties ## Properties
### fulfillment\_options ### fulfillment\_options
• **fulfillment\_options**: [`FulfillmentOption`](internal-19.FulfillmentOption.md)[] • **fulfillment\_options**: [`FulfillmentOption`](internal-22.FulfillmentOption.md)[]
#### Defined in #### Defined in
docs/content/references/js-client/classes/internal-19.AdminPostRegionsRegionCountriesReq.md → docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionCountriesReq.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Class: AdminPostRegionsRegionCountriesReq # Class: AdminPostRegionsRegionCountriesReq
[internal](../modules/internal-19.md).AdminPostRegionsRegionCountriesReq [internal](../modules/internal-22.md).AdminPostRegionsRegionCountriesReq
## Properties ## Properties
Loaded 100 of 238 files, more files were not shown because too many files have changed in this diff. Show more