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

chore(docs): Generated JS Client Reference (#5334)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2023-10-10 17:47:07 +00:00
1 parent 378ca1b36e
commit daea35fe73
1091 files changed
+140791 -25954
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs-util/packages/scripts/package.json
+1
View File
@@ -22,6 +22,7 @@
"typedoc-plugin-markdown": "3.16.0", "typedoc-plugin-markdown": "3.16.0",
"typedoc-plugin-markdown-medusa": "*", "typedoc-plugin-markdown-medusa": "*",
"typedoc-plugin-merge-modules": "5.1.0", "typedoc-plugin-merge-modules": "5.1.0",
"typedoc-plugin-missing-exports": "^2.1.0",
"typedoc-plugin-modules": "*", "typedoc-plugin-modules": "*",
"typedoc-plugin-reference-excluder": "1.1.3", "typedoc-plugin-reference-excluder": "1.1.3",
"typedoc-plugin-rename-defaults": "^0.6.6", "typedoc-plugin-rename-defaults": "^0.6.6",
docs-util/packages/typedoc-config/js-client.js
+4 -3
View File
@@ -20,15 +20,16 @@ module.exports = {
"typedoc-plugin-merge-modules", "typedoc-plugin-merge-modules",
"typedoc-plugin-reference-excluder", "typedoc-plugin-reference-excluder",
"typedoc-plugin-frontmatter", "typedoc-plugin-frontmatter",
"typedoc-plugin-modules",
], ],
exclude: [ exclude: [
path.join(pathPrefix, "packages/medusa-js/src/resources/base.ts"), path.join(pathPrefix, "packages/medusa-js/src/resources/base.ts"),
"node_modules/**", path.join(pathPrefix, "node_modules/**"),
"packages/**/node_modules", path.join(pathPrefix, "packages/**/node_modules"),
], ],
excludeConstructors: true, excludeConstructors: true,
frontmatterData: { frontmatterData: {
displayed_sidebar: "jsClientSidebar", displayed_sidebar: "jsClientSidebar",
}, },
pagesPattern: "internal\\.", internalModule: "internal",
} }
docs-util/packages/typedoc-plugin-frontmatter/package.json
-1
View File
@@ -23,7 +23,6 @@
}, },
"devDependencies": { "devDependencies": {
"@types/node": "^16.11.10", "@types/node": "^16.11.10",
"typedoc": "^0.25.1",
"typescript": "^4.6" "typescript": "^4.6"
}, },
"keywords": [ "keywords": [
docs-util/packages/typedoc-plugin-modules/src/resolve-references-plugin.ts
+8
View File
@@ -146,6 +146,14 @@ export function load(app: Application) {
} }
} while (missing.size > 0) } while (missing.size > 0)
// remove paths from reflection name
internalNs?.children?.forEach((item) => {
if (item.name.indexOf(`"`) === 0) {
item.name =
context.converter.application.options.getValue("internalModule")
}
})
// All the missing symbols were excluded, so get rid of our namespace. // All the missing symbols were excluded, so get rid of our namespace.
if (internalNs && !internalNs.children?.length) { if (internalNs && !internalNs.children?.length) {
context.project.removeReflection(internalNs) context.project.removeReflection(internalNs)
docs-util/yarn.lock
+10
View File
@@ -2434,6 +2434,7 @@ __metadata:
typedoc-plugin-markdown: 3.16.0 typedoc-plugin-markdown: 3.16.0
typedoc-plugin-markdown-medusa: "*" typedoc-plugin-markdown-medusa: "*"
typedoc-plugin-merge-modules: 5.1.0 typedoc-plugin-merge-modules: 5.1.0
typedoc-plugin-missing-exports: ^2.1.0
typedoc-plugin-modules: "*" typedoc-plugin-modules: "*"
typedoc-plugin-reference-excluder: 1.1.3 typedoc-plugin-reference-excluder: 1.1.3
typedoc-plugin-rename-defaults: ^0.6.6 typedoc-plugin-rename-defaults: ^0.6.6
@@ -2870,6 +2871,15 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"typedoc-plugin-missing-exports@npm:^2.1.0":
version: 2.1.0
resolution: "typedoc-plugin-missing-exports@npm:2.1.0"
peerDependencies:
typedoc: 0.24.x || 0.25.x
checksum: 65ba23913e389b473df770ad4b0e29cb1f90c9a11bc6f554863203618d5db23c5296686d03fb6b37dcad75e902d3f7711b5c6589a513cd0a2494f2440c170690
languageName: node
linkType: hard
"typedoc-plugin-modules@*, typedoc-plugin-modules@workspace:packages/typedoc-plugin-modules": "typedoc-plugin-modules@*, typedoc-plugin-modules@workspace:packages/typedoc-plugin-modules":
version: 0.0.0-use.local version: 0.0.0-use.local
resolution: "typedoc-plugin-modules@workspace:packages/typedoc-plugin-modules" resolution: "typedoc-plugin-modules@workspace:packages/typedoc-plugin-modules"
packages/medusa/src/interfaces/payment-service.ts
+3 -3
View File
@@ -65,7 +65,7 @@ export interface PaymentService extends TransactionBaseService {
createPayment(context: Cart & PaymentContext): Promise<PaymentSessionResponse> createPayment(context: Cart & PaymentContext): Promise<PaymentSessionResponse>
/** /**
* This will be @deprecated in the near future use createPayment(context: Cart & PaymentContext): Promise<PaymentSessionResponse> instead * This will be @deprecated in the near future use createPayment(context: `Cart & PaymentContext): Promise<PaymentSessionResponse>` instead
* @param cart * @param cart
*/ */
createPayment(cart: Cart): Promise<PaymentSessionData> createPayment(cart: Cart): Promise<PaymentSessionData>
@@ -183,7 +183,7 @@ export abstract class AbstractPaymentService
): Promise<PaymentSessionResponse> ): Promise<PaymentSessionResponse>
/** /**
* This will be @deprecated in the near future use createPayment(context: Cart & PaymentContext): Promise<PaymentSessionResponse> instead * This will be @deprecated in the near future use `createPayment(context: Cart & PaymentContext): Promise<PaymentSessionResponse>` instead
* @param cart * @param cart
*/ */
public abstract createPayment(cart: Cart): Promise<PaymentSessionData> public abstract createPayment(cart: Cart): Promise<PaymentSessionData>
@@ -205,7 +205,7 @@ export abstract class AbstractPaymentService
): Promise<PaymentSessionResponse | PaymentSessionResponse["session_data"]> ): Promise<PaymentSessionResponse | PaymentSessionResponse["session_data"]>
/** /**
* This will be @deprecated in the near future use updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise<PaymentSessionResponse> instead * This will be @deprecated in the near future use `updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise<PaymentSessionResponse>` instead
* @param paymentSessionData * @param paymentSessionData
* @param cart * @param cart
*/ */
www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx
+2 -2
View File
@@ -191,9 +191,9 @@ This request accepts [many request-body parameters](https://docs.medusajs.com/ap
- `code`: This parameter is required. It is a unique code. The customer redeems the discount using this code. - `code`: This parameter is required. It is a unique code. The customer redeems the discount using this code.
- `rule`: This parameter is required. It is an object having at least the following fields: - `rule`: This parameter is required. It is an object having at least the following fields:
- `type`: A string indicating the type of discount. It can be `fixed`, `percentage`, or `free_shipping`. When using the Medusa JS Client, you must use the enum type [DiscountRuleType](../../../references/js-client/enums/internal.discountruletype/) for the value. - `type`: A string indicating the type of discount. It can be `fixed`, `percentage`, or `free_shipping`. When using the Medusa JS Client, you must use the enum type [DiscountRuleType](../../../references/js-client/enums/internal-3.DiscountRuleType.md) for the value.
- `value`: A number indicating the value of the discount. If the discount type is `fixed`, then it will be the fixed amount to discount from the cart’s totals or its items. If the discount type is `percentage`, then it will be the percentage to discount from the items in the cart. If the type is `free_shipping`, it has no effect and can be set to `0`. - `value`: A number indicating the value of the discount. If the discount type is `fixed`, then it will be the fixed amount to discount from the cart’s totals or its items. If the discount type is `percentage`, then it will be the percentage to discount from the items in the cart. If the type is `free_shipping`, it has no effect and can be set to `0`.
- `allocation`: A string indicating how the discount should be applied. Can be `item` or `total`. If the type is not `fixed`, then this has no effect. When using the Medusa JS Client, you must use the enum type [AllocationType](../../../references/js-client/enums/internal.allocationtype/) for the value. - `allocation`: A string indicating how the discount should be applied. Can be `item` or `total`. If the type is not `fixed`, then this has no effect. When using the Medusa JS Client, you must use the enum type [AllocationType](../../../references/js-client/enums/internal-3.AllocationType.md) for the value.
- `regions`: An array of region IDs this discount can be used in. If the type of discount is `fixed`, only one region can be passed. - `regions`: An array of region IDs this discount can be used in. If the type of discount is `fixed`, only one region can be passed.
This request returns the full `discount` object. This request returns the full `discount` object.
www/apps/docs/content/references/js-client/classes/AddressesResource.md
+16 -12
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AddressesResource # Class: AddressesResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,7 @@
### addAddress ### addAddress
▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> ▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
Adds an address to a customers saved addresses Adds an address to a customers saved addresses
@@ -19,21 +23,21 @@ Adds an address to a customers saved addresses
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerAddressesReq`](internal.StorePostCustomersCustomerAddressesReq.md) | contains information to create an address | | `payload` | [`StorePostCustomersCustomerAddressesReq`](internal.StorePostCustomersCustomerAddressesReq.md) | contains information to create an address |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/addresses.ts#L16) [packages/medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/addresses.ts#L16)
___ ___
### deleteAddress ### deleteAddress
▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> ▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
Deletes an address of a customer Deletes an address of a customer
@@ -42,21 +46,21 @@ Deletes an address of a customer
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `address_id` | `string` | id of the address to delete | | `address_id` | `string` | id of the address to delete |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/addresses.ts#L30) [packages/medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/addresses.ts#L30)
___ ___
### updateAddress ### updateAddress
▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> ▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
Update an address of a customer Update an address of a customer
@@ -66,12 +70,12 @@ Update an address of a customer
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `address_id` | `string` | id of customer | | `address_id` | `string` | id of customer |
| `payload` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | address update | | `payload` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | address update |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/addresses.ts#L45) [packages/medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/addresses.ts#L45)
www/apps/docs/content/references/js-client/classes/Admin.md
+87 -33
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: Admin # Class: Admin
## Hierarchy ## Hierarchy
@@ -14,7 +18,7 @@
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L37) [packages/medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L42)
___ ___
@@ -24,7 +28,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L38) [packages/medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L43)
___ ___
@@ -34,7 +38,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L43) [packages/medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L48)
___ ___
@@ -44,7 +48,17 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L42) [packages/medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L47)
___
### custom
• **custom**: [`AdminCustomResource`](AdminCustomResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:79](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L79)
___ ___
@@ -54,7 +68,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L40) [packages/medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L45)
___ ___
@@ -64,7 +78,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L39) [packages/medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L44)
___ ___
@@ -74,7 +88,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L41) [packages/medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L46)
___ ___
@@ -84,7 +98,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L44) [packages/medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L49)
___ ___
@@ -94,7 +108,17 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L45) [packages/medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L50)
___
### inventoryItems
• **inventoryItems**: [`AdminInventoryItemsResource`](AdminInventoryItemsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L52)
___ ___
@@ -104,7 +128,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L46) [packages/medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L51)
___ ___
@@ -114,7 +138,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L47) [packages/medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L53)
___ ___
@@ -124,7 +148,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L65) [packages/medusa-js/src/resources/admin/index.ts:73](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L73)
___ ___
@@ -134,7 +158,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L55) [packages/medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L61)
___ ___
@@ -144,7 +168,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L54) [packages/medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L60)
___ ___
@@ -154,7 +178,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L68) [packages/medusa-js/src/resources/admin/index.ts:76](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L76)
___ ___
@@ -164,7 +188,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:69](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L69) [packages/medusa-js/src/resources/admin/index.ts:77](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L77)
___ ___
@@ -174,7 +198,17 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L48) [packages/medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L54)
___
### productCategories
• **productCategories**: [`AdminProductCategoriesResource`](AdminProductCategoriesResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L78)
___ ___
@@ -184,7 +218,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L50) [packages/medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L56)
___ ___
@@ -194,7 +228,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L51) [packages/medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L57)
___ ___
@@ -204,7 +238,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L49) [packages/medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L55)
___ ___
@@ -214,7 +248,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L56) [packages/medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L62)
___ ___
@@ -224,7 +258,17 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L64) [packages/medusa-js/src/resources/admin/index.ts:71](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L71)
___
### reservations
• **reservations**: [`AdminReservationsResource`](AdminReservationsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:72](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L72)
___ ___
@@ -234,7 +278,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L57) [packages/medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L63)
___ ___
@@ -244,7 +288,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L53) [packages/medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L59)
___ ___
@@ -254,7 +298,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L59) [packages/medusa-js/src/resources/admin/index.ts:65](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L65)
___ ___
@@ -264,7 +308,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L63) [packages/medusa-js/src/resources/admin/index.ts:70](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L70)
___ ___
@@ -274,7 +318,17 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L61) [packages/medusa-js/src/resources/admin/index.ts:67](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L67)
___
### stockLocations
• **stockLocations**: [`AdminStockLocationsResource`](AdminStockLocationsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:68](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L68)
___ ___
@@ -284,7 +338,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L62) [packages/medusa-js/src/resources/admin/index.ts:69](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L69)
___ ___
@@ -294,7 +348,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L60) [packages/medusa-js/src/resources/admin/index.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L66)
___ ___
@@ -304,7 +358,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L66) [packages/medusa-js/src/resources/admin/index.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L74)
___ ___
@@ -314,7 +368,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:67](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L67) [packages/medusa-js/src/resources/admin/index.ts:75](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L75)
___ ___
@@ -324,7 +378,7 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L52) [packages/medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L58)
___ ___
@@ -334,4 +388,4 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L58) [packages/medusa-js/src/resources/admin/index.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L64)
www/apps/docs/content/references/js-client/classes/AdminAuthResource.md
+49 -20
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminAuthResource # Class: AdminAuthResource
## Hierarchy ## Hierarchy
@@ -10,72 +14,97 @@
### createSession ### createSession
▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> ▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
**`Description`**
Creates an authenticated session
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) | | `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
**`Description`**
Creates an authenticated session
#### Defined in #### Defined in
[medusa-js/src/resources/admin/auth.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/auth.ts#L37) [packages/medusa-js/src/resources/admin/auth.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/auth.ts#L38)
___ ___
### deleteSession ### deleteSession
▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> ▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
**`Description`**
destroys an authenticated session
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
**`Description`**
destroys an authenticated session
#### Defined in #### Defined in
[medusa-js/src/resources/admin/auth.ts:24](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/auth.ts#L24) [packages/medusa-js/src/resources/admin/auth.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/auth.ts#L25)
___ ___
### getSession ### getSession
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> ▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
**`Description`** **`Description`**
Retrieves an authenticated session Retrieves an authenticated session
Usually used to check if authenticated session is alive. Usually used to check if authenticated session is alive.
#### Defined in
[packages/medusa-js/src/resources/admin/auth.ts:13](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/auth.ts#L13)
___
### getToken
▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBearerAuthRes`](../modules/internal-1.md#adminbearerauthres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBearerAuthRes`](../modules/internal-1.md#adminbearerauthres)\>
**`Description`**
Retrieves a new JWT access token
#### Defined in #### Defined in
[medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/auth.ts#L12) [packages/medusa-js/src/resources/admin/auth.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/auth.ts#L52)
www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.md
+24 -20
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminBatchJobsResource # Class: AdminBatchJobsResource
## Hierarchy ## Hierarchy
@@ -10,103 +14,103 @@
### cancel ### cancel
▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> ▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `batchJobId` | `string` | | `batchJobId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/batch-jobs.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L35) [packages/medusa-js/src/resources/admin/batch-jobs.ts:35](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L35)
___ ___
### confirm ### confirm
▸ **confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> ▸ **confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `batchJobId` | `string` | | `batchJobId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/batch-jobs.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L43) [packages/medusa-js/src/resources/admin/batch-jobs.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L43)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostBatchesReq`](internal-2.AdminPostBatchesReq.md) | | `payload` | [`AdminPostBatchesReq`](internal-2.AdminPostBatchesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/batch-jobs.ts:13](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L13) [packages/medusa-js/src/resources/admin/batch-jobs.ts:13](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L13)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetBatchParams`](internal-2.AdminGetBatchParams.md) | | `query?` | [`AdminGetBatchParams`](internal-2.AdminGetBatchParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/batch-jobs.ts:21](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L21) [packages/medusa-js/src/resources/admin/batch-jobs.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L21)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> ▸ **retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `batchJobId` | `string` | | `batchJobId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/batch-jobs.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L51) [packages/medusa-js/src/resources/admin/batch-jobs.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L51)
www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.md
+60 -56
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminCollectionsResource # Class: AdminCollectionsResource
## Hierarchy ## Hierarchy
@@ -10,11 +14,7 @@
### addProducts ### addProducts
▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> ▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
**`Description`**
Updates products associated with a Product Collection
#### Parameters #### Parameters
@@ -22,106 +22,106 @@ Updates products associated with a Product Collection
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | the id of the Collection | | `id` | `string` | the id of the Collection |
| `payload` | [`AdminPostProductsToCollectionReq`](internal-3.AdminPostProductsToCollectionReq.md) | an object which contains an array of Product IDs to add to the Product Collection | | `payload` | [`AdminPostProductsToCollectionReq`](internal-3.AdminPostProductsToCollectionReq.md) | an object which contains an array of Product IDs to add to the Product Collection |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
**`Description`**
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/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L100) [packages/medusa-js/src/resources/admin/collections.ts:101](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L101)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
**`Description`**
Creates a collection.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostCollectionsReq`](internal-3.AdminPostCollectionsReq.md) | | `payload` | [`AdminPostCollectionsReq`](internal-3.AdminPostCollectionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
Created collection. Created collection.
**`Description`**
Creates a collection.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/collections.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L22) [packages/medusa-js/src/resources/admin/collections.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L23)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
deletes a collection
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of collection to delete. | | `id` | `string` | id of collection to delete. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
Deleted response Deleted response
**`Description`**
deletes a collection
#### Defined in #### Defined in
[medusa-js/src/resources/admin/collections.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L52) [packages/medusa-js/src/resources/admin/collections.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L53)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
**`Description`**
Lists collections matching a query
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`AdminGetCollectionsParams`](internal-3.AdminGetCollectionsParams.md) | Query for searching collections | | `query?` | [`AdminGetCollectionsParams`](internal-3.AdminGetCollectionsParams.md) | Query for searching collections |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
a list of collections matching the query. a list of collections matching the query.
**`Description`**
Lists collections matching a query
#### Defined in #### Defined in
[medusa-js/src/resources/admin/collections.ts:80](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L80) [packages/medusa-js/src/resources/admin/collections.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L81)
___ ___
### removeProducts ### removeProducts
▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\>
**`Description`**
Removes products associated with a Product Collection
#### Parameters #### Parameters
@@ -129,52 +129,52 @@ Removes products associated with a Product Collection
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | the id of the Collection | | `id` | `string` | the id of the Collection |
| `payload` | [`AdminDeleteProductsFromCollectionReq`](internal-3.AdminDeleteProductsFromCollectionReq.md) | an object which contains an array of Product IDs to add to the Product Collection | | `payload` | [`AdminDeleteProductsFromCollectionReq`](internal-3.AdminDeleteProductsFromCollectionReq.md) | an object which contains an array of Product IDs to add to the Product Collection |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\>
**`Description`**
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/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L115) [packages/medusa-js/src/resources/admin/collections.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L116)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
**`Description`**
get a collection
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the collection to retrieve. | | `id` | `string` | id of the collection to retrieve. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
the collection with the given id the collection with the given id
**`Description`**
get a collection
#### Defined in #### Defined in
[medusa-js/src/resources/admin/collections.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L66) [packages/medusa-js/src/resources/admin/collections.ts:67](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L67)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
**`Description`**
Updates a collection
#### Parameters #### Parameters
@@ -182,14 +182,18 @@ Updates a collection
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the collection to update. | | `id` | `string` | id of the collection to update. |
| `payload` | [`AdminPostCollectionsCollectionReq`](internal-3.AdminPostCollectionsCollectionReq.md) | update to apply to collection. | | `payload` | [`AdminPostCollectionsCollectionReq`](internal-3.AdminPostCollectionsCollectionReq.md) | update to apply to collection. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
the updated collection. the updated collection.
**`Description`**
Updates a collection
#### Defined in #### Defined in
[medusa-js/src/resources/admin/collections.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L37) [packages/medusa-js/src/resources/admin/collections.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L38)
www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.md
+29 -25
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminCurrenciesResource # Class: AdminCurrenciesResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,20 @@
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\>
the list of currencies as well as the pagination properties.
**`Description`** **`Description`**
@@ -18,34 +35,15 @@ Lists currencies.
This feature is under development and may change in the future. This feature is under development and may change in the future.
To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project. To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\>
the list of currencies as well as the pagination properties.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/currencies.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/currencies.ts#L20) [packages/medusa-js/src/resources/admin/currencies.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/currencies.ts#L20)
___ ___
### update ### update
▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> ▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\>
**`Description`**
Updates a currency
This feature is under development and may change in the future.
To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project.
#### Parameters #### Parameters
@@ -53,14 +51,20 @@ To use this feature please enable featureflag `tax_inclusive_pricing` in your me
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `code` | `string` | code of the currency to update. | | `code` | `string` | code of the currency to update. |
| `payload` | [`AdminPostCurrenciesCurrencyReq`](internal-4.AdminPostCurrenciesCurrencyReq.md) | update to apply to currency. | | `payload` | [`AdminPostCurrenciesCurrencyReq`](internal-4.AdminPostCurrenciesCurrencyReq.md) | update to apply to currency. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\>
the updated currency. the updated currency.
**`Description`**
Updates a currency
This feature is under development and may change in the future.
To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/currencies.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/currencies.ts#L43) [packages/medusa-js/src/resources/admin/currencies.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/currencies.ts#L43)
www/apps/docs/content/references/js-client/classes/AdminCustomResource.md
+99
View File
@@ -0,0 +1,99 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminCustomResource
## Hierarchy
- `default`
↳ **`AdminCustomResource`**
## Methods
### delete
▸ **delete**<`TResponse`\>(`path`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `TResponse` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) |
| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Defined in
[packages/medusa-js/src/resources/admin/custom.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L47)
___
### get
▸ **get**<`TQuery`, `TResponse`\>(`path`, `query?`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `TQuery` | extends [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `TResponse` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
| `query?` | `TQuery` |
| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) |
| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Defined in
[packages/medusa-js/src/resources/admin/custom.ts:8](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L8)
___
### post
▸ **post**<`TPayload`, `TResponse`\>(`path`, `payload?`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Type parameters
| Name | Type |
| :------ | :------ |
| `TPayload` | extends [`Record`](../modules/internal.md#record)<`string`, `any`\> |
| `TResponse` | `any` |
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `string` |
| `payload?` | `TPayload` |
| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) |
| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\>
#### Defined in
[packages/medusa-js/src/resources/admin/custom.ts:30](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L30)
www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md
+43 -39
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminCustomerGroupsResource # Class: AdminCustomerGroupsResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,7 @@
### addCustomers ### addCustomers
▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> ▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
Add multiple customers to a customer group. Add multiple customers to a customer group.
@@ -19,22 +23,22 @@ Add multiple customers to a customer group.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | customer group id | | `id` | `string` | customer group id |
| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group | | `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L112) [packages/medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L112)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
Create a customer group. Create a customer group.
@@ -42,22 +46,22 @@ Create a customer group.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`AdminPostCustomerGroupsReq`](internal-5.AdminPostCustomerGroupsReq.md) | customer group info | | `payload` | [`AdminPostCustomerGroupsReq`](internal-6.AdminPostCustomerGroupsReq.md) | customer group info |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L26) [packages/medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L26)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
Deletes a customer group. Deletes a customer group.
@@ -66,21 +70,21 @@ Deletes a customer group.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the customer group | | `id` | `string` | id of the customer group |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L77) [packages/medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L77)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-5.md#admincustomergroupslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-6.md#admincustomergroupslistres)\>
Lists customer groups. Lists customer groups.
@@ -88,22 +92,22 @@ Lists customer groups.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`AdminGetCustomerGroupsParams`](internal-5.AdminGetCustomerGroupsParams.md) | optional | | `query?` | [`AdminGetCustomerGroupsParams`](internal-6.AdminGetCustomerGroupsParams.md) | optional |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-5.md#admincustomergroupslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-6.md#admincustomergroupslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L91) [packages/medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L91)
___ ___
### listCustomers ### listCustomers
▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> ▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\>
List and count customers that belong to provided customer groups. List and count customers that belong to provided customer groups.
@@ -112,22 +116,22 @@ List and count customers that belong to provided customer groups.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | customer group id | | `id` | `string` | customer group id |
| `query?` | [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) | params for filtering customers | | `query?` | [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) | params for filtering customers |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L144) [packages/medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L144)
___ ___
### removeCustomers ### removeCustomers
▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> ▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
Remove multiple customers from a customer group. Remove multiple customers from a customer group.
@@ -136,22 +140,22 @@ Remove multiple customers from a customer group.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | customer group id | | `id` | `string` | customer group id |
| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group | | `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L128) [packages/medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L128)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> ▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
Retrieves a customer group. Retrieves a customer group.
@@ -160,22 +164,22 @@ Retrieves a customer group.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | customer group id | | `id` | `string` | customer group id |
| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-5.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. | | `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-6.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L41) [packages/medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L41)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
Updates a customer group Updates a customer group
@@ -184,13 +188,13 @@ Updates a customer group
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | customer group id | | `id` | `string` | customer group id |
| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-5.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with | | `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-6.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L62) [packages/medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L62)
www/apps/docs/content/references/js-client/classes/AdminCustomersResource.md
+23 -19
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminCustomersResource # Class: AdminCustomersResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,7 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\>
Creates a customer Creates a customer
@@ -18,22 +22,22 @@ Creates a customer
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`AdminPostCustomersReq`](internal-6.AdminPostCustomersReq.md) | information of customer | | `payload` | [`AdminPostCustomersReq`](internal-7.AdminPostCustomersReq.md) | information of customer |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customers.ts#L18) [packages/medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customers.ts#L18)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\>
Lists customers Lists customers
@@ -41,22 +45,22 @@ Lists customers
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) | optional | | `query?` | [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) | optional |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customers.ts#L59) [packages/medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customers.ts#L59)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\>
Retrieves a customer Retrieves a customer
@@ -65,21 +69,21 @@ Retrieves a customer
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | customer id | | `id` | `string` | customer id |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customers.ts#L46) [packages/medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customers.ts#L46)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\>
Updates a customer Updates a customer
@@ -88,13 +92,13 @@ Updates a customer
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | customer id | | `id` | `string` | customer id |
| `payload` | [`AdminPostCustomersCustomerReq`](internal-6.AdminPostCustomersCustomerReq.md) | data to update customer with | | `payload` | [`AdminPostCustomersCustomerReq`](internal-7.AdminPostCustomersCustomerReq.md) | data to update customer with |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customers.ts#L32) [packages/medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customers.ts#L32)
www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.md
+176 -172
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDiscountsResource # Class: AdminDiscountsResource
## Hierarchy ## Hierarchy
@@ -10,194 +14,190 @@
### addConditionResourceBatch ### addConditionResourceBatch
▸ **addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `conditionId` | `string` |
| `payload` | [`AdminPostDiscountsDiscountConditionsConditionBatchReq`](internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) |
| `query?` | [`AdminPostDiscountsDiscountConditionsConditionBatchParams`](internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`** **`Description`**
Add a batch of items to a discount condition Add a batch of items to a discount condition
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `conditionId` | `string` |
| `payload` | [`AdminPostDiscountsDiscountConditionsConditionBatchReq`](internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) |
| `query?` | [`AdminPostDiscountsDiscountConditionsConditionBatchParams`](internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:218](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L218) [packages/medusa-js/src/resources/admin/discounts.ts:218](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L218)
___ ___
### addRegion ### addRegion
▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `regionId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`** **`Description`**
Adds region to discount Adds region to discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `regionId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L27) [packages/medusa-js/src/resources/admin/discounts.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L27)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostDiscountsReq`](internal-8.AdminPostDiscountsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`** **`Description`**
Creates discounts Creates discounts
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostDiscountsReq`](internal-7.AdminPostDiscountsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L39) [packages/medusa-js/src/resources/admin/discounts.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L39)
___ ___
### createCondition ### createCondition
▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `payload` | [`AdminPostDiscountsDiscountConditions`](internal-8.AdminPostDiscountsDiscountConditions.md) |
| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal-8.AdminPostDiscountsDiscountConditionsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`** **`Description`**
creates a discount condition creates a discount condition
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `payload` | [`AdminPostDiscountsDiscountConditions`](internal-7.AdminPostDiscountsDiscountConditions.md) |
| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal-7.AdminPostDiscountsDiscountConditionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:148](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L148) [packages/medusa-js/src/resources/admin/discounts.ts:148](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L148)
___ ___
### createDynamicCode ### createDynamicCode
▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`** **`Description`**
Creates a dynamic discount code Creates a dynamic discount code
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L62) [packages/medusa-js/src/resources/admin/discounts.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L62)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
Deletes a discount
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
Deletes a discount
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:74](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L74) [packages/medusa-js/src/resources/admin/discounts.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L74)
___ ___
### deleteCondition ### deleteCondition
▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `conditionId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`** **`Description`**
Removes a condition from a discount Removes a condition from a discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `conditionId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:187](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L187) [packages/medusa-js/src/resources/admin/discounts.ts:187](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L187)
___ ___
### deleteConditionResourceBatch ### deleteConditionResourceBatch
▸ **deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Delete a batch of items from a discount condition
#### Parameters #### Parameters
@@ -205,26 +205,26 @@ Delete a batch of items from a discount condition
| :------ | :------ | | :------ | :------ |
| `discountId` | `string` | | `discountId` | `string` |
| `conditionId` | `string` | | `conditionId` | `string` |
| `payload` | [`AdminDeleteDiscountsDiscountConditionsConditionBatchReq`](internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) | | `payload` | [`AdminDeleteDiscountsDiscountConditionsConditionBatchReq`](internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
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/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L238) [packages/medusa-js/src/resources/admin/discounts.ts:238](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L238)
___ ___
### deleteDynamicCode ### deleteDynamicCode
▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Deletes a dynamic discount
#### Parameters #### Parameters
@@ -232,25 +232,25 @@ Deletes a dynamic discount
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `code` | `string` | | `code` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Deletes a dynamic discount
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:85](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L85) [packages/medusa-js/src/resources/admin/discounts.ts:85](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L85)
___ ___
### getCondition ### getCondition
▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-7.md#admindiscountconditionsres)\> ▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-8.md#admindiscountconditionsres)\>
**`Description`**
Gets a condition from a discount
#### Parameters #### Parameters
@@ -258,51 +258,51 @@ Gets a condition from a discount
| :------ | :------ | | :------ | :------ |
| `discountId` | `string` | | `discountId` | `string` |
| `conditionId` | `string` | | `conditionId` | `string` |
| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md) | | `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-7.md#admindiscountconditionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-8.md#admindiscountconditionsres)\>
**`Description`**
Gets a condition from a discount
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:199](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L199) [packages/medusa-js/src/resources/admin/discounts.ts:199](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L199)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-7.md#admindiscountslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-8.md#admindiscountslistres)\>
**`Description`**
Lists discounts
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetDiscountsParams`](internal-7.AdminGetDiscountsParams.md) | | `query?` | [`AdminGetDiscountsParams`](internal-8.AdminGetDiscountsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-7.md#admindiscountslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-8.md#admindiscountslistres)\>
**`Description`**
Lists discounts
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:119](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L119) [packages/medusa-js/src/resources/admin/discounts.ts:119](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L119)
___ ___
### removeRegion ### removeRegion
▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Removes a region from a discount
#### Parameters #### Parameters
@@ -310,101 +310,101 @@ Removes a region from a discount
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `regionId` | `string` | | `regionId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Removes a region from a discount
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:136](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L136) [packages/medusa-js/src/resources/admin/discounts.ts:136](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L136)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Retrieves a discount
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Retrieves a discount
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:97](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L97) [packages/medusa-js/src/resources/admin/discounts.ts:97](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L97)
___ ___
### retrieveByCode ### retrieveByCode
▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Retrieves a discount by code
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `code` | `string` | | `code` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Retrieves a discount by code
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:108](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L108) [packages/medusa-js/src/resources/admin/discounts.ts:108](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L108)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Updates discount
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostDiscountsDiscountReq`](internal-7.AdminPostDiscountsDiscountReq.md) | | `payload` | [`AdminPostDiscountsDiscountReq`](internal-8.AdminPostDiscountsDiscountReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Updates discount
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L50) [packages/medusa-js/src/resources/admin/discounts.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L50)
___ ___
### updateCondition ### updateCondition
▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> ▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Updates a discount condition
#### Parameters #### Parameters
@@ -412,14 +412,18 @@ Updates a discount condition
| :------ | :------ | | :------ | :------ |
| `discountId` | `string` | | `discountId` | `string` |
| `conditionId` | `string` | | `conditionId` | `string` |
| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-7.AdminPostDiscountsDiscountConditionsCondition.md) | | `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-8.AdminPostDiscountsDiscountConditionsCondition.md) |
| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md) | | `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
**`Description`**
Updates a discount condition
#### Defined in #### Defined in
[medusa-js/src/resources/admin/discounts.ts:167](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L167) [packages/medusa-js/src/resources/admin/discounts.ts:167](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L167)
www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.md
+115 -111
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDraftOrdersResource # Class: AdminDraftOrdersResource
## Hierarchy ## Hierarchy
@@ -10,214 +14,210 @@
### addLineItem ### addLineItem
▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> ▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
**`Description`** **`Description`**
Add line item to draft order Add line item to draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:30](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L30) [packages/medusa-js/src/resources/admin/draft-orders.ts:30](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L30)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostDraftOrdersReq`](internal-8.internal.AdminPostDraftOrdersReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
**`Description`** **`Description`**
Creates a draft order Creates a draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostDraftOrdersReq`](internal-8.AdminPostDraftOrdersReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L20) [packages/medusa-js/src/resources/admin/draft-orders.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L20)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`** **`Description`**
Delete draft order Delete draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:42](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L42) [packages/medusa-js/src/resources/admin/draft-orders.ts:42](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L42)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.md#admindraftorderslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.internal.md#admindraftorderslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetDraftOrdersParams`](internal-8.internal.AdminGetDraftOrdersParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.internal.md#admindraftorderslistres)\>
**`Description`** **`Description`**
Lists draft orders Lists draft orders
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetDraftOrdersParams`](internal-8.AdminGetDraftOrdersParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.md#admindraftorderslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:76](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L76) [packages/medusa-js/src/resources/admin/draft-orders.ts:76](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L76)
___ ___
### markPaid ### markPaid
▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.md#adminpostdraftordersdraftorderregisterpaymentres)\> ▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.internal.md#adminpostdraftordersdraftorderregisterpaymentres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.internal.md#adminpostdraftordersdraftorderregisterpaymentres)\>
**`Description`** **`Description`**
Mark a draft order as paid Mark a draft order as paid
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.md#adminpostdraftordersdraftorderregisterpaymentres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:93](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L93) [packages/medusa-js/src/resources/admin/draft-orders.ts:93](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L93)
___ ___
### removeLineItem ### removeLineItem
▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> ▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `itemId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
**`Description`** **`Description`**
Remove line item Remove line item
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `itemId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:53](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L53) [packages/medusa-js/src/resources/admin/draft-orders.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L53)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
**`Description`** **`Description`**
Retrieves a draft order Retrieves a draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L65) [packages/medusa-js/src/resources/admin/draft-orders.ts:65](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L65)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
**`Description`**
Update draft order
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.AdminPostDraftOrdersDraftOrderReq.md) | | `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
**`Description`**
Update draft order
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:104](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L104) [packages/medusa-js/src/resources/admin/draft-orders.ts:104](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L104)
___ ___
### updateLineItem ### updateLineItem
▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> ▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
**`Description`**
Update draft order line item
#### Parameters #### Parameters
@@ -225,13 +225,17 @@ Update draft order line item
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `itemId` | `string` | | `itemId` | `string` |
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) | | `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
**`Description`**
Update draft order line item
#### Defined in #### Defined in
[medusa-js/src/resources/admin/draft-orders.ts:116](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L116) [packages/medusa-js/src/resources/admin/draft-orders.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L116)
www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.md
+60 -56
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGiftCardsResource # Class: AdminGiftCardsResource
## Hierarchy ## Hierarchy
@@ -10,124 +14,124 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostGiftCardsReq`](internal-8.internal.AdminPostGiftCardsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
**`Description`** **`Description`**
Creates a gift card Creates a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostGiftCardsReq`](internal-9.AdminPostGiftCardsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L17) [packages/medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L17)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
Deletes a gift card
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
Deletes a gift card
#### Defined in #### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L40) [packages/medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L40)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-9.md#admingiftcardslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.internal.md#admingiftcardslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetGiftCardsParams`](internal-8.internal.AdminGetGiftCardsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.internal.md#admingiftcardslistres)\>
**`Description`** **`Description`**
Lists gift cards Lists gift cards
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetGiftCardsParams`](internal-9.AdminGetGiftCardsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-9.md#admingiftcardslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L62) [packages/medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L62)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
**`Description`** **`Description`**
Deletes a gift card Deletes a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L51) [packages/medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L51)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
**`Description`**
Updates a gift card
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-9.AdminPostGiftCardsGiftCardReq.md) | | `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-8.internal.AdminPostGiftCardsGiftCardReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
**`Description`**
Updates a gift card
#### Defined in #### Defined in
[medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L28) [packages/medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L28)
www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.md
+302
View File
@@ -0,0 +1,302 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminInventoryItemsResource
## Hierarchy
- `default`
↳ **`AdminInventoryItemsResource`**
## Methods
### create
▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
Create an Inventory Item
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostInventoryItemsReq`](internal-8.internal.AdminPostInventoryItemsReq.md) |
| `query?` | [`AdminPostInventoryItemsParams`](internal-8.internal.AdminPostInventoryItemsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
the created Inventory Item
**`Description`**
creates an Inventory Item
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:88](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L88)
___
### createLocationLevel
▸ **createLocationLevel**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
Create stock for an Inventory Item at a Stock Location
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `inventoryItemId` | `string` |
| `payload` | [`AdminPostInventoryItemsItemLocationLevelsReq`](internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md) |
| `query?` | [`AdminGetInventoryItemsParams`](internal-8.internal.AdminGetInventoryItemsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
the Inventory Item
**`Description`**
creates stock levle for an Inventory Item
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:155](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L155)
___
### delete
▸ **delete**(`inventoryItemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
Delete an Inventory Item
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `inventoryItemId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
the deleted Inventory Item
**`Description`**
deletes an Inventory Item
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:73](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L73)
___
### deleteLocationLevel
▸ **deleteLocationLevel**(`inventoryItemId`, `locationId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
Removes an Inventory Item from a Stock Location. This erases trace of any quantity currently at the location.
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `inventoryItemId` | `string` |
| `locationId` | `string` |
| `query?` | [`AdminGetInventoryItemsParams`](internal-8.internal.AdminGetInventoryItemsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
the Inventory Item
**`Description`**
deletes a location level of an Inventory Item
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:178](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L178)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../modules/internal-8.internal.md#admininventoryitemslistwithvariantsandlocationlevelsres)\>
Retrieve a list of Inventory Items
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetInventoryItemsParams`](internal-8.internal.AdminGetInventoryItemsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../modules/internal-8.internal.md#admininventoryitemslistwithvariantsandlocationlevelsres)\>
the list of Inventory Items as well as the pagination properties
**`Description`**
Retrieve a list of Inventory Items
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:110](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L110)
___
### listLocationLevels
▸ **listLocationLevels**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../modules/internal-8.internal.md#admininventoryitemslocationlevelsres)\>
Retrieve a list of Inventory Levels related to an Inventory Item across Stock Locations
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `inventoryItemId` | `string` |
| `query?` | [`AdminGetInventoryItemsItemLocationLevelsParams`](internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../modules/internal-8.internal.md#admininventoryitemslocationlevelsres)\>
the list of inventory levels related to an Inventory Item as well as the pagination properties
**`Description`**
Retrieve a list of location levels related to an Inventory Item
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:201](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L201)
___
### retrieve
▸ **retrieve**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
Retrieve an Inventory Item
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `inventoryItemId` | `string` |
| `query?` | [`AdminGetInventoryItemsItemParams`](internal-8.internal.AdminGetInventoryItemsItemParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
an Inventory Item
**`Description`**
gets an Inventory Item
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L28)
___
### update
▸ **update**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
Update an Inventory Item
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `inventoryItemId` | `string` |
| `payload` | [`AdminPostInventoryItemsInventoryItemReq`](internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md) |
| `query?` | [`AdminGetInventoryItemsItemParams`](internal-8.internal.AdminGetInventoryItemsItemParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
the updated Inventory Item
**`Description`**
updates an Inventory Item
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L50)
___
### updateLocationLevel
▸ **updateLocationLevel**(`inventoryItemId`, `locationId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
Update an Inventory Item's stock level at a Stock Location
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `inventoryItemId` | `string` |
| `locationId` | `string` |
| `payload` | [`AdminPostInventoryItemsItemLocationLevelsLevelReq`](internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md) |
| `query?` | [`AdminGetInventoryItemsParams`](internal-8.internal.AdminGetInventoryItemsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\>
the updated Inventory Item
**`Description`**
updates an Inventory Item
#### Defined in
[packages/medusa-js/src/resources/admin/inventory-item.ts:131](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L131)
www/apps/docs/content/references/js-client/classes/AdminInvitesResource.md
+26 -22
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminInvitesResource # Class: AdminInvitesResource
## Hierarchy ## Hierarchy
@@ -10,102 +14,102 @@
### accept ### accept
▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> ▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-10.AdminPostInvitesInviteAcceptReq.md) | | `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-8.internal.AdminPostInvitesInviteAcceptReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)
#### Defined in #### Defined in
[medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L10) [packages/medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L10)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostInvitesPayload`](../modules/internal-10.md#adminpostinvitespayload) | | `payload` | [`AdminPostInvitesPayload`](../modules/internal-9.md#adminpostinvitespayload) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)
#### Defined in #### Defined in
[medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L18) [packages/medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L18)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L26) [packages/medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L26)
___ ___
### list ### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-10.md#adminlistinvitesres)\> ▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-8.internal.md#adminlistinvitesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-10.md#adminlistinvitesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-8.internal.md#adminlistinvitesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L34) [packages/medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L34)
___ ___
### resend ### resend
▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> ▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)
#### Defined in #### Defined in
[medusa-js/src/resources/admin/invites.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L41) [packages/medusa-js/src/resources/admin/invites.ts:41](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L41)
www/apps/docs/content/references/js-client/classes/AdminNotesResource.md
+27 -23
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminNotesResource # Class: AdminNotesResource
## Hierarchy ## Hierarchy
@@ -10,104 +14,104 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostNotesReq`](internal-11.AdminPostNotesReq.md) | | `payload` | [`AdminPostNotesReq`](internal-8.internal.AdminPostNotesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L14) [packages/medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L14)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L31) [packages/medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L31)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-11.md#adminnoteslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-8.internal.md#adminnoteslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetNotesParams`](internal-11.AdminGetNotesParams.md) | | `query?` | [`AdminGetNotesParams`](internal-8.internal.AdminGetNotesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-11.md#adminnoteslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-8.internal.md#adminnoteslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L47) [packages/medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L47)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L39) [packages/medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L39)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostNotesNoteReq`](internal-11.AdminPostNotesNoteReq.md) | | `payload` | [`AdminPostNotesNoteReq`](internal-8.internal.AdminPostNotesNoteReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L22) [packages/medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L22)
www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.md
+14 -10
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminNotificationsResource # Class: AdminNotificationsResource
## Hierarchy ## Hierarchy
@@ -10,41 +14,41 @@
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-12.md#adminnotificationslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-8.internal.md#adminnotificationslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetNotificationsParams`](internal-12.AdminGetNotificationsParams.md) | | `query?` | [`AdminGetNotificationsParams`](internal-8.internal.AdminGetNotificationsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-12.md#adminnotificationslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-8.internal.md#adminnotificationslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notifications.ts#L12) [packages/medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notifications.ts#L12)
___ ___
### resend ### resend
▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-12.md#adminnotificationsres)\> ▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-8.internal.md#adminnotificationsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-12.AdminPostNotificationsNotificationResendReq.md) | | `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-8.internal.AdminPostNotificationsNotificationResendReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-12.md#adminnotificationsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-8.internal.md#adminnotificationsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notifications.ts#L26) [packages/medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notifications.ts#L26)
www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.md
+58 -54
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminOrderEditsResource # Class: AdminOrderEditsResource
## Hierarchy ## Hierarchy
@@ -10,113 +14,113 @@
### addLineItem ### addLineItem
▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrderEditsEditLineItemsReq`](internal-13.AdminPostOrderEditsEditLineItemsReq.md) | | `payload` | [`AdminPostOrderEditsEditLineItemsReq`](internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:72](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L72) [packages/medusa-js/src/resources/admin/order-edits.ts:72](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L72)
___ ___
### cancel ### cancel
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:98](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L98) [packages/medusa-js/src/resources/admin/order-edits.ts:98](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L98)
___ ___
### confirm ### confirm
▸ **confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:106](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L106) [packages/medusa-js/src/resources/admin/order-edits.ts:106](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L106)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostOrderEditsReq`](internal-13.AdminPostOrderEditsReq.md) | | `payload` | [`AdminPostOrderEditsReq`](internal-8.internal.AdminPostOrderEditsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L47) [packages/medusa-js/src/resources/admin/order-edits.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L47)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L64) [packages/medusa-js/src/resources/admin/order-edits.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L64)
___ ___
### deleteItemChange ### deleteItemChange
▸ **deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-13.md#adminorderedititemchangedeleteres)\> ▸ **deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-8.internal.md#adminorderedititemchangedeleteres)\>
#### Parameters #### Parameters
@@ -124,42 +128,42 @@ ___
| :------ | :------ | | :------ | :------ |
| `orderEditId` | `string` | | `orderEditId` | `string` |
| `itemChangeId` | `string` | | `itemChangeId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-13.md#adminorderedititemchangedeleteres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-8.internal.md#adminorderedititemchangedeleteres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:81](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L81) [packages/medusa-js/src/resources/admin/order-edits.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L81)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-13.md#adminordereditslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-8.internal.md#adminordereditslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`GetOrderEditsParams`](internal-13.GetOrderEditsParams.md) | | `query?` | [`GetOrderEditsParams`](internal-8.internal.GetOrderEditsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-13.md#adminordereditslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-8.internal.md#adminordereditslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:33](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L33) [packages/medusa-js/src/resources/admin/order-edits.ts:33](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L33)
___ ___
### removeLineItem ### removeLineItem
▸ **removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
@@ -167,86 +171,86 @@ ___
| :------ | :------ | | :------ | :------ |
| `orderEditId` | `string` | | `orderEditId` | `string` |
| `itemId` | `string` | | `itemId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:124](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L124) [packages/medusa-js/src/resources/admin/order-edits.ts:124](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L124)
___ ___
### requestConfirmation ### requestConfirmation
▸ **requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:90](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L90) [packages/medusa-js/src/resources/admin/order-edits.ts:90](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L90)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`GetOrderEditsOrderEditParams`](internal-13.GetOrderEditsOrderEditParams.md) | | `query?` | [`GetOrderEditsOrderEditParams`](internal-8.internal.GetOrderEditsOrderEditParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L18) [packages/medusa-js/src/resources/admin/order-edits.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L18)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrderEditsOrderEditReq`](internal-13.AdminPostOrderEditsOrderEditReq.md) | | `payload` | [`AdminPostOrderEditsOrderEditReq`](internal-8.internal.AdminPostOrderEditsOrderEditReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:55](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L55) [packages/medusa-js/src/resources/admin/order-edits.ts:55](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L55)
___ ___
### updateLineItem ### updateLineItem
▸ **updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> ▸ **updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Parameters #### Parameters
@@ -254,13 +258,13 @@ ___
| :------ | :------ | | :------ | :------ |
| `orderEditId` | `string` | | `orderEditId` | `string` |
| `itemId` | `string` | | `itemId` | `string` |
| `payload` | [`AdminPostOrderEditsEditLineItemsLineItemReq`](internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md) | | `payload` | [`AdminPostOrderEditsEditLineItemsLineItemReq`](internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/order-edits.ts:114](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L114) [packages/medusa-js/src/resources/admin/order-edits.ts:114](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L114)
www/apps/docs/content/references/js-client/classes/AdminOrdersResource.md
+119 -115
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminOrdersResource # Class: AdminOrdersResource
## Hierarchy ## Hierarchy
@@ -10,71 +14,71 @@
### addShippingMethod ### addShippingMethod
▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-14.AdminPostOrdersOrderShippingMethodsReq.md) | | `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:152](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L152) [packages/medusa-js/src/resources/admin/orders.ts:152](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L152)
___ ___
### archive ### archive
▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L161) [packages/medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L161)
___ ___
### cancel ### cancel
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L144) [packages/medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L144)
___ ___
### cancelClaim ### cancelClaim
▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -82,21 +86,21 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `claimId` | `string` | | `claimId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:225](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L225) [packages/medusa-js/src/resources/admin/orders.ts:225](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L225)
___ ___
### cancelClaimFulfillment ### cancelClaimFulfillment
▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -105,21 +109,21 @@ ___
| `id` | `string` | | `id` | `string` |
| `claimId` | `string` | | `claimId` | `string` |
| `fulfillmentId` | `string` | | `fulfillmentId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:116](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L116) [packages/medusa-js/src/resources/admin/orders.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L116)
___ ___
### cancelFulfillment ### cancelFulfillment
▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -127,21 +131,21 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `fulfillmentId` | `string` | | `fulfillmentId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:97](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L97) [packages/medusa-js/src/resources/admin/orders.ts:97](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L97)
___ ___
### cancelSwap ### cancelSwap
▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -149,21 +153,21 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `swapId` | `string` | | `swapId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:178](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L178) [packages/medusa-js/src/resources/admin/orders.ts:178](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L178)
___ ___
### cancelSwapFulfillment ### cancelSwapFulfillment
▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -172,85 +176,85 @@ ___
| `id` | `string` | | `id` | `string` |
| `swapId` | `string` | | `swapId` | `string` |
| `fulfillmentId` | `string` | | `fulfillmentId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:106](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L106) [packages/medusa-js/src/resources/admin/orders.ts:106](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L106)
___ ___
### capturePayment ### capturePayment
▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L71) [packages/medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L71)
___ ___
### complete ### complete
▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L63) [packages/medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L63)
___ ___
### createClaim ### createClaim
▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-14.AdminPostOrdersOrderClaimsReq.md) | | `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-8.internal.AdminPostOrdersOrderClaimsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:216](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L216) [packages/medusa-js/src/resources/admin/orders.ts:216](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L216)
___ ___
### createClaimShipment ### createClaimShipment
▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -258,88 +262,88 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `claimId` | `string` | | `claimId` | `string` |
| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) | | `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:254](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L254) [packages/medusa-js/src/resources/admin/orders.ts:254](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L254)
___ ___
### createFulfillment ### createFulfillment
▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-14.AdminPostOrdersOrderFulfillmentsReq.md) | | `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:88](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L88) [packages/medusa-js/src/resources/admin/orders.ts:88](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L88)
___ ___
### createShipment ### createShipment
▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-14.AdminPostOrdersOrderShipmentReq.md) | | `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-8.internal.AdminPostOrdersOrderShipmentReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:126](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L126) [packages/medusa-js/src/resources/admin/orders.ts:126](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L126)
___ ___
### createSwap ### createSwap
▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-14.AdminPostOrdersOrderSwapsReq.md) | | `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-8.internal.AdminPostOrdersOrderSwapsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:169](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L169) [packages/medusa-js/src/resources/admin/orders.ts:169](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L169)
___ ___
### createSwapShipment ### createSwapShipment
▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -347,22 +351,22 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `swapId` | `string` | | `swapId` | `string` |
| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) | | `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:197](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L197) [packages/medusa-js/src/resources/admin/orders.ts:197](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L197)
___ ___
### fulfillClaim ### fulfillClaim
▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -370,22 +374,22 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `claimId` | `string` | | `claimId` | `string` |
| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) | | `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:244](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L244) [packages/medusa-js/src/resources/admin/orders.ts:244](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L244)
___ ___
### fulfillSwap ### fulfillSwap
▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -393,43 +397,43 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `swapId` | `string` | | `swapId` | `string` |
| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) | | `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:187](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L187) [packages/medusa-js/src/resources/admin/orders.ts:187](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L187)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-14.md#adminorderslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-8.internal.md#adminorderslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetOrdersParams`](internal-14.AdminGetOrdersParams.md) | | `query?` | [`AdminGetOrdersParams`](internal-8.internal.AdminGetOrdersParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-14.md#adminorderslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-8.internal.md#adminorderslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L49) [packages/medusa-js/src/resources/admin/orders.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L49)
___ ___
### processSwapPayment ### processSwapPayment
▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -437,109 +441,109 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `swapId` | `string` | | `swapId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:207](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L207) [packages/medusa-js/src/resources/admin/orders.ts:207](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L207)
___ ___
### refundPayment ### refundPayment
▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-14.AdminPostOrdersOrderRefundsReq.md) | | `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-8.internal.AdminPostOrdersOrderRefundsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:79](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L79) [packages/medusa-js/src/resources/admin/orders.ts:79](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L79)
___ ___
### requestReturn ### requestReturn
▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-14.AdminPostOrdersOrderReturnsReq.md) | | `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-8.internal.AdminPostOrdersOrderReturnsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:135](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L135) [packages/medusa-js/src/resources/admin/orders.ts:135](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L135)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`FindParams`](internal-5.FindParams.md) | | `query?` | [`FindParams`](internal-6.FindParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L34) [packages/medusa-js/src/resources/admin/orders.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L34)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostOrdersOrderReq`](internal-14.AdminPostOrdersOrderReq.md) | | `payload` | [`AdminPostOrdersOrderReq`](internal-8.internal.AdminPostOrdersOrderReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L25) [packages/medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L25)
___ ___
### updateClaim ### updateClaim
▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> ▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Parameters #### Parameters
@@ -547,13 +551,13 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `claimId` | `string` | | `claimId` | `string` |
| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-14.AdminPostOrdersOrderClaimsClaimReq.md) | | `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/orders.ts:234](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L234) [packages/medusa-js/src/resources/admin/orders.ts:234](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L234)
www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md
+22 -18
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPaymentCollectionsResource # Class: AdminPaymentCollectionsResource
## Hierarchy ## Hierarchy
@@ -10,84 +14,84 @@
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-15.md#adminpaymentcollectiondeleteres)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-8.internal.md#adminpaymentcollectiondeleteres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-15.md#adminpaymentcollectiondeleteres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-8.internal.md#adminpaymentcollectiondeleteres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/payment-collections.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payment-collections.ts#L36) [packages/medusa-js/src/resources/admin/payment-collections.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payment-collections.ts#L36)
___ ___
### markAsAuthorized ### markAsAuthorized
▸ **markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> ▸ **markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/payment-collections.ts:44](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payment-collections.ts#L44) [packages/medusa-js/src/resources/admin/payment-collections.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payment-collections.ts#L44)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> ▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) | | `query?` | [`AdminGetPaymentCollectionsParams`](internal-8.internal.AdminGetPaymentCollectionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/payment-collections.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payment-collections.ts#L12) [packages/medusa-js/src/resources/admin/payment-collections.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payment-collections.ts#L12)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminUpdatePaymentCollectionsReq`](internal-15.AdminUpdatePaymentCollectionsReq.md) | | `payload` | [`AdminUpdatePaymentCollectionsReq`](internal-8.internal.AdminUpdatePaymentCollectionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/payment-collections.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payment-collections.ts#L27) [packages/medusa-js/src/resources/admin/payment-collections.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payment-collections.ts#L27)
www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.md
+18 -14
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPaymentsResource # Class: AdminPaymentsResource
## Hierarchy ## Hierarchy
@@ -10,63 +14,63 @@
### capturePayment ### capturePayment
▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> ▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/payments.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payments.ts#L27) [packages/medusa-js/src/resources/admin/payments.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payments.ts#L27)
___ ___
### refundPayment ### refundPayment
▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRefundRes`](../modules/internal-16.md#adminrefundres)\> ▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRefundRes`](../modules/internal-8.internal.md#adminrefundres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostPaymentRefundsReq`](internal-16.AdminPostPaymentRefundsReq.md) | | `payload` | [`AdminPostPaymentRefundsReq`](internal-8.internal.AdminPostPaymentRefundsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRefundRes`](../modules/internal-16.md#adminrefundres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRefundRes`](../modules/internal-8.internal.md#adminrefundres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/payments.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payments.ts#L35) [packages/medusa-js/src/resources/admin/payments.ts:35](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payments.ts#L35)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> ▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`GetPaymentsParams`](internal-16.GetPaymentsParams.md) | | `query?` | [`GetPaymentsParams`](internal-8.internal.GetPaymentsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/payments.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payments.ts#L12) [packages/medusa-js/src/resources/admin/payments.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payments.ts#L12)
www/apps/docs/content/references/js-client/classes/AdminPriceListResource.md
+72 -46
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPriceListResource # Class: AdminPriceListResource
## Hierarchy ## Hierarchy
@@ -10,93 +14,93 @@
### addPrices ### addPrices
▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> ▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-17.AdminPostPriceListPricesPricesReq.md) | | `payload` | [`AdminPostPriceListPricesPricesReq`](internal-8.internal.AdminPostPriceListPricesPricesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L80) [packages/medusa-js/src/resources/admin/price-lists.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L81)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostPriceListsPriceListReq`](internal-17.AdminPostPriceListsPriceListReq.md) | | `payload` | [`AdminPostPriceListsPriceListReq`](internal-8.internal.AdminPostPriceListsPriceListReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L18) [packages/medusa-js/src/resources/admin/price-lists.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L19)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L35) [packages/medusa-js/src/resources/admin/price-lists.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L36)
___ ___
### deletePrices ### deletePrices
▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> ▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-17.AdminDeletePriceListPricesPricesReq.md) | | `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-8.internal.AdminDeletePriceListPricesPricesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L89) [packages/medusa-js/src/resources/admin/price-lists.ts:90](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L90)
___ ___
### deleteProductPrices ### deleteProductPrices
▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> ▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\>
#### Parameters #### Parameters
@@ -104,21 +108,43 @@ ___
| :------ | :------ | | :------ | :------ |
| `priceListId` | `string` | | `priceListId` | `string` |
| `productId` | `string` | | `productId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L98) [packages/medusa-js/src/resources/admin/price-lists.ts:99](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L99)
___
### deleteProductsPrices
▸ **deleteProductsPrices**(`priceListId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `priceListId` | `string` |
| `payload` | [`AdminDeletePriceListsPriceListProductsPricesBatchReq`](internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:117](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L117)
___ ___
### deleteVariantPrices ### deleteVariantPrices
▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> ▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\>
#### Parameters #### Parameters
@@ -126,98 +152,98 @@ ___
| :------ | :------ | | :------ | :------ |
| `priceListId` | `string` | | `priceListId` | `string` |
| `variantId` | `string` | | `variantId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L107) [packages/medusa-js/src/resources/admin/price-lists.ts:108](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L108)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-17.md#adminpricelistslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-8.internal.md#adminpricelistslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetPriceListPaginationParams`](internal-17.AdminGetPriceListPaginationParams.md) | | `query?` | [`AdminGetPriceListPaginationParams`](internal-8.internal.AdminGetPriceListPaginationParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-17.md#adminpricelistslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-8.internal.md#adminpricelistslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L51) [packages/medusa-js/src/resources/admin/price-lists.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L52)
___ ___
### listProducts ### listProducts
▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> ▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`any`\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-17.AdminGetPriceListsPriceListProductsParams.md) | | `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-8.internal.AdminGetPriceListsPriceListProductsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`any`\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L65) [packages/medusa-js/src/resources/admin/price-lists.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L66)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L43) [packages/medusa-js/src/resources/admin/price-lists.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L44)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-17.AdminPostPriceListsPriceListPriceListReq.md) | | `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L26) [packages/medusa-js/src/resources/admin/price-lists.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L27)
www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.md
+222
View File
@@ -0,0 +1,222 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminProductCategoriesResource
## Hierarchy
- `default`
↳ **`AdminProductCategoriesResource`**
## Methods
### addProducts
▸ **addProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
Add products to a product category
This feature is under development and may change in the future.
To use this feature please enable featureflag `product_categories` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `productCategoryId` | `string` |
| `payload` | [`AdminPostProductCategoriesCategoryProductsBatchReq`](internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
a medusa product category
**`Description`**
Add products to a product category
#### Defined in
[packages/medusa-js/src/resources/admin/product-categories.ts:126](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L126)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostProductCategoriesReq`](internal-8.internal.AdminPostProductCategoriesReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/product-categories.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L44)
___
### delete
▸ **delete**(`productCategoryId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
Delete a product category
This feature is under development and may change in the future.
To use this feature please enable featureflag `product_categories` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `productCategoryId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
an deletion result
**`Description`**
gets a product category
#### Defined in
[packages/medusa-js/src/resources/admin/product-categories.ts:95](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L95)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesListRes`](../modules/internal-8.internal.md#adminproductcategorieslistres)\>
Retrieve a list of product categories
This feature is under development and may change in the future.
To use this feature please enable featureflag `product_categories` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetProductCategoriesParams`](internal-8.internal.AdminGetProductCategoriesParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesListRes`](../modules/internal-8.internal.md#adminproductcategorieslistres)\>
the list of product category as well as the pagination properties
**`Description`**
Retrieve a list of product categories
#### Defined in
[packages/medusa-js/src/resources/admin/product-categories.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L74)
___
### removeProducts
▸ **removeProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
Remove products from a product category
This feature is under development and may change in the future.
To use this feature please enable featureflag `product_categories` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `productCategoryId` | `string` |
| `payload` | [`AdminDeleteProductCategoriesCategoryProductsBatchReq`](internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
a medusa product category
**`Description`**
Remove products from a product category
#### Defined in
[packages/medusa-js/src/resources/admin/product-categories.ts:110](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L110)
___
### retrieve
▸ **retrieve**(`productCategoryId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
retrieve a product category
This feature is under development and may change in the future.
To use this feature please enable featureflag `product_categories` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `productCategoryId` | `string` |
| `query?` | [`AdminGetProductCategoryParams`](internal-8.internal.AdminGetProductCategoryParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
a medusa product category
**`Description`**
gets a product category
#### Defined in
[packages/medusa-js/src/resources/admin/product-categories.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L25)
___
### update
▸ **update**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
update a product category
This feature is under development and may change in the future.
To use this feature please enable featureflag `product_categories` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `productCategoryId` | `string` |
| `payload` | [`AdminPostProductCategoriesCategoryReq`](internal-8.internal.AdminPostProductCategoriesCategoryReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\>
the updated medusa product category
**`Description`**
updates a product category
#### Defined in
[packages/medusa-js/src/resources/admin/product-categories.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L58)
www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.md
+8 -4
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminProductTagsResource # Class: AdminProductTagsResource
## Hierarchy ## Hierarchy
@@ -10,18 +14,18 @@
### list ### list
▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-18.md#adminproducttagslistres)\> ▸ **list**(`query?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-8.internal.md#adminproducttagslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetProductTagsParams`](internal-18.AdminGetProductTagsParams.md) | | `query?` | [`AdminGetProductTagsParams`](internal-8.internal.AdminGetProductTagsParams.md) |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-18.md#adminproducttagslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-8.internal.md#adminproducttagslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/product-tags.ts#L10) [packages/medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-tags.ts#L10)
www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.md
+9 -5
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminProductTypesResource # Class: AdminProductTypesResource
## Hierarchy ## Hierarchy
@@ -10,19 +14,19 @@
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-19.md#adminproducttypeslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-8.internal.md#adminproducttypeslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetProductTypesParams`](internal-19.AdminGetProductTypesParams.md) | | `query?` | [`AdminGetProductTypesParams`](internal-8.internal.AdminGetProductTypesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-19.md#adminproducttypeslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-8.internal.md#adminproducttypeslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/product-types.ts#L10) [packages/medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-types.ts#L10)
www/apps/docs/content/references/js-client/classes/AdminProductsResource.md
+72 -68
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminProductsResource # Class: AdminProductsResource
## Hierarchy ## Hierarchy
@@ -10,93 +14,93 @@
### addOption ### addOption
▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> ▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostProductsProductOptionsReq`](internal-20.AdminPostProductsProductOptionsReq.md) | | `payload` | [`AdminPostProductsProductOptionsReq`](internal-8.internal.AdminPostProductsProductOptionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:124](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L124) [packages/medusa-js/src/resources/admin/products.ts:124](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L124)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostProductsReq`](internal-20.AdminPostProductsReq.md) | | `payload` | [`AdminPostProductsReq`](internal-8.internal.AdminPostProductsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L23) [packages/medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L23)
___ ___
### createVariant ### createVariant
▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> ▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostProductsProductVariantsReq`](internal-20.AdminPostProductsProductVariantsReq.md) | | `payload` | [`AdminPostProductsProductVariantsReq`](internal-8.internal.AdminPostProductsProductVariantsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:96](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L96) [packages/medusa-js/src/resources/admin/products.ts:96](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L96)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-20.md#adminproductsdeleteres)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-8.internal.md#adminproductsdeleteres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-20.md#adminproductsdeleteres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-8.internal.md#adminproductsdeleteres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L48) [packages/medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L48)
___ ___
### deleteOption ### deleteOption
▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-20.md#adminproductsdeleteoptionres)\> ▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-8.internal.md#adminproductsdeleteoptionres)\>
#### Parameters #### Parameters
@@ -104,21 +108,21 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `optionId` | `string` | | `optionId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-20.md#adminproductsdeleteoptionres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-8.internal.md#adminproductsdeleteoptionres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:143](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L143) [packages/medusa-js/src/resources/admin/products.ts:143](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L143)
___ ___
### deleteVariant ### deleteVariant
▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-20.md#adminproductsdeletevariantres)\> ▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-8.internal.md#adminproductsdeletevariantres)\>
#### Parameters #### Parameters
@@ -126,151 +130,151 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `variantId` | `string` | | `variantId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-20.md#adminproductsdeletevariantres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-8.internal.md#adminproductsdeletevariantres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:115](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L115) [packages/medusa-js/src/resources/admin/products.ts:115](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L115)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-20.md#adminproductslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-8.internal.md#adminproductslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetProductsParams`](internal-20.AdminGetProductsParams.md) | | `query?` | [`AdminGetProductsParams`](internal-8.internal.AdminGetProductsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-20.md#adminproductslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-8.internal.md#adminproductslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L56) [packages/medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L56)
___ ___
### listTags ### listTags
▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-20.md#adminproductslisttagsres)\> ▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-8.internal.md#adminproductslisttagsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-20.md#adminproductslisttagsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-8.internal.md#adminproductslisttagsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:80](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L80) [packages/medusa-js/src/resources/admin/products.ts:80](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L80)
___ ___
### listTypes ### listTypes
▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-20.md#adminproductslisttypesres)\> ▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-8.internal.md#adminproductslisttypesres)\>
**`Deprecated`**
Use [list](AdminProductTypesResource.md#list) instead.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-20.md#adminproductslisttypesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-8.internal.md#adminproductslisttypesres)\>
**`Deprecated`**
Use [AdminProductTypesResource.list](AdminProductTypesResource.md#list) instead.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:73](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L73) [packages/medusa-js/src/resources/admin/products.ts:73](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L73)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L31) [packages/medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L31)
___ ___
### setMetadata ### setMetadata
▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> ▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostProductsProductMetadataReq`](internal-20.AdminPostProductsProductMetadataReq.md) | | `payload` | [`AdminPostProductsProductMetadataReq`](internal-8.internal.AdminPostProductsProductMetadataReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:87](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L87) [packages/medusa-js/src/resources/admin/products.ts:87](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L87)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostProductsProductReq`](internal-20.AdminPostProductsProductReq.md) | | `payload` | [`AdminPostProductsProductReq`](internal-8.internal.AdminPostProductsProductReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L39) [packages/medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L39)
___ ___
### updateOption ### updateOption
▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> ▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Parameters #### Parameters
@@ -278,22 +282,22 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `optionId` | `string` | | `optionId` | `string` |
| `payload` | [`AdminPostProductsProductOptionsOption`](internal-20.AdminPostProductsProductOptionsOption.md) | | `payload` | [`AdminPostProductsProductOptionsOption`](internal-8.internal.AdminPostProductsProductOptionsOption.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:133](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L133) [packages/medusa-js/src/resources/admin/products.ts:133](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L133)
___ ___
### updateVariant ### updateVariant
▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> ▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Parameters #### Parameters
@@ -301,13 +305,13 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `variantId` | `string` | | `variantId` | `string` |
| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-20.AdminPostProductsProductVariantsVariantReq.md) | | `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-8.internal.AdminPostProductsProductVariantsVariantReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/products.ts:105](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L105) [packages/medusa-js/src/resources/admin/products.ts:105](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L105)
www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md
+44 -40
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPublishableApiKeyResource # Class: AdminPublishableApiKeyResource
## Hierarchy ## Hierarchy
@@ -10,136 +14,136 @@
### addSalesChannelsBatch ### addSalesChannelsBatch
▸ **addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> ▸ **addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostPublishableApiKeySalesChannelsBatchReq`](internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md) | | `payload` | [`AdminPostPublishableApiKeySalesChannelsBatchReq`](internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:82](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L82) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:82](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L82)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostPublishableApiKeysReq`](internal-21.AdminPostPublishableApiKeysReq.md) | | `payload` | [`AdminPostPublishableApiKeysReq`](internal-8.internal.AdminPostPublishableApiKeysReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L49) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L49)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L66) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L66)
___ ___
### deleteSalesChannelsBatch ### deleteSalesChannelsBatch
▸ **deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> ▸ **deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeletePublishableApiKeySalesChannelsBatchReq`](internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) | | `payload` | [`AdminDeletePublishableApiKeySalesChannelsBatchReq`](internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:91](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L91) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:91](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L91)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-21.md#adminpublishableapikeyslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-8.internal.md#adminpublishableapikeyslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`GetPublishableApiKeysParams`](internal-21.GetPublishableApiKeysParams.md) | | `query?` | [`GetPublishableApiKeysParams`](internal-8.internal.GetPublishableApiKeysParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-21.md#adminpublishableapikeyslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-8.internal.md#adminpublishableapikeyslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L35) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:35](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L35)
___ ___
### listSalesChannels ### listSalesChannels
▸ **listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-21.md#adminsaleschannelslistres)\> ▸ **listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`GetPublishableApiKeySalesChannelsParams`](internal-21.GetPublishableApiKeySalesChannelsParams.md) | | `query?` | [`GetPublishableApiKeySalesChannelsParams`](internal-8.internal.GetPublishableApiKeySalesChannelsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-21.md#adminsaleschannelslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:100](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L100) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:100](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L100)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> ▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Parameters #### Parameters
@@ -147,36 +151,36 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | `Object` | | `query?` | `Object` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L20) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L20)
___ ___
### revoke ### revoke
▸ **revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> ▸ **revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:74](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L74) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L74)
___ ___
@@ -189,8 +193,8 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostPublishableApiKeysPublishableApiKeyReq`](internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md) | | `payload` | [`AdminPostPublishableApiKeysPublishableApiKeyReq`](internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
@@ -198,4 +202,4 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/admin/publishable-api-keys.ts:57](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L57) [packages/medusa-js/src/resources/admin/publishable-api-keys.ts:57](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L57)
www/apps/docs/content/references/js-client/classes/AdminRegionsResource.md
+120 -116
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminRegionsResource # Class: AdminRegionsResource
## Hierarchy ## Hierarchy
@@ -10,149 +14,145 @@
### addCountry ### addCountry
▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-8.internal.AdminPostRegionsRegionCountriesReq.md) | country data |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
updated region
**`Description`** **`Description`**
adds a country to the list of countries in a region adds a country to the list of countries in a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-22.AdminPostRegionsRegionCountriesReq.md) | country data |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L103) [packages/medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L103)
___ ___
### addFulfillmentProvider ### addFulfillmentProvider
▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
updated region
**`Description`** **`Description`**
adds a fulfillment provider to a region adds a fulfillment provider to a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L135) [packages/medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L135)
___ ___
### addPaymentProvider ### addPaymentProvider
▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
**`Description`**
adds a payment provider to a region
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | region id | | `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-22.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data | | `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
updated region updated region
**`Description`**
adds a payment provider to a region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L181) [packages/medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L181)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
**`Description`**
creates a region.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostRegionsReq`](internal-22.AdminPostRegionsReq.md) | | `payload` | [`AdminPostRegionsReq`](internal-8.internal.AdminPostRegionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
created region. created region.
**`Description`**
creates a region.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L24) [packages/medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L24)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
deletes a region
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of region to delete. | | `id` | `string` | id of region to delete. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
Deleted response Deleted response
**`Description`**
deletes a region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L54) [packages/medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L54)
___ ___
### deleteCountry ### deleteCountry
▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
**`Description`**
remove a country from a region's list of coutnries
#### Parameters #### Parameters
@@ -160,27 +160,27 @@ remove a country from a region's list of coutnries
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | region id | | `id` | `string` | region id |
| `country_code` | `string` | the 2 character ISO code for the Country. | | `country_code` | `string` | the 2 character ISO code for the Country. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
updated region updated region
**`Description`**
remove a country from a region's list of coutnries
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L119) [packages/medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L119)
___ ___
### deleteFulfillmentProvider ### deleteFulfillmentProvider
▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
**`Description`**
remove a fulfillment provider from a region
#### Parameters #### Parameters
@@ -188,27 +188,27 @@ remove a fulfillment provider from a region
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | region id | | `id` | `string` | region id |
| `provider_id` | `string` | the if of the fulfillment provider | | `provider_id` | `string` | the if of the fulfillment provider |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
updated region updated region
**`Description`**
remove a fulfillment provider from a region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L151) [packages/medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L151)
___ ___
### deletePaymentProvider ### deletePaymentProvider
▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
**`Description`**
removes a payment provider from a region
#### Parameters #### Parameters
@@ -216,123 +216,127 @@ removes a payment provider from a region
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | region id | | `id` | `string` | region id |
| `provider_id` | `string` | the id of the payment provider | | `provider_id` | `string` | the id of the payment provider |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
updated region updated region
**`Description`**
removes a payment provider from a region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L197) [packages/medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L197)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.md#adminregionslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-8.internal.md#adminregionslistres)\>
**`Description`**
lists regions matching a query
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`AdminGetRegionsParams`](internal-22.AdminGetRegionsParams.md) | query for searching regions | | `query?` | [`AdminGetRegionsParams`](internal-8.internal.AdminGetRegionsParams.md) | query for searching regions |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.md#adminregionslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-8.internal.md#adminregionslistres)\>
a list of regions matching the query. a list of regions matching the query.
**`Description`**
lists regions matching a query
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L82) [packages/medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L82)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
**`Description`**
get a region
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the region to retrieve. | | `id` | `string` | id of the region to retrieve. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
the region with the given id the region with the given id
**`Description`**
get a region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L68) [packages/medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L68)
___ ___
### retrieveFulfillmentOptions ### retrieveFulfillmentOptions
▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> ▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
**`Description`**
retrieves the list of fulfillment options available in a region
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | region id | | `id` | `string` | region id |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
list of fulfillment options list of fulfillment options
**`Description`**
retrieves the list of fulfillment options available in a region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L166) [packages/medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L166)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
**`Description`**
updates a region
#### Parameters #### Parameters
| 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-22.AdminPostRegionsRegionReq.md) | update to apply to region. | | `payload` | [`AdminPostRegionsRegionReq`](internal-8.internal.AdminPostRegionsRegionReq.md) | update to apply to region. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
the updated region. the updated region.
**`Description`**
updates a region
#### Defined in #### Defined in
[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L39) [packages/medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L39)
www/apps/docs/content/references/js-client/classes/AdminReservationsResource.md
+167
View File
@@ -0,0 +1,167 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminReservationsResource
## Hierarchy
- `default`
↳ **`AdminReservationsResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\>
create a reservation
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostReservationsReq`](internal-8.internal.AdminPostReservationsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\>
the created reservation
**`Description`**
create a reservation
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Defined in
[packages/medusa-js/src/resources/admin/reservations.ts:57](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L57)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
remove a reservation
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
reservation removal confirmation
**`Description`**
remove a reservation
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Defined in
[packages/medusa-js/src/resources/admin/reservations.ts:88](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L88)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsListRes`](../modules/internal-8.internal.md#adminreservationslistres)\>
List reservations
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetReservationsParams`](internal-8.internal.AdminGetReservationsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsListRes`](../modules/internal-8.internal.md#adminreservationslistres)\>
A list of reservations matching the provided query
**`Description`**
Lists reservations
#### Defined in
[packages/medusa-js/src/resources/admin/reservations.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L36)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\>
Get a reservation
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\>
The reservation with the provided id
**`Description`**
gets a reservation
#### Defined in
[packages/medusa-js/src/resources/admin/reservations.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L21)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\>
update a reservation
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostReservationsReservationReq`](internal-8.internal.AdminPostReservationsReservationReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\>
The updated reservation
**`Description`**
update a reservation
This feature is under development and may change in the future.
To use this feature please install @medusajs/inventory
#### Defined in
[packages/medusa-js/src/resources/admin/reservations.ts:72](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L72)
www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.md
+46 -42
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminReturnReasonsResource # Class: AdminReturnReasonsResource
## Hierarchy ## Hierarchy
@@ -10,133 +14,133 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
**`Description`**
Creates a return reason.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostReturnReasonsReq`](internal-23.AdminPostReturnReasonsReq.md) | | `payload` | [`AdminPostReturnReasonsReq`](internal-8.internal.AdminPostReturnReasonsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
Created return reason. Created return reason.
**`Description`**
Creates a return reason.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L18) [packages/medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L18)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
deletes a return reason
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of return reason to delete. | | `id` | `string` | id of return reason to delete. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
Deleted response Deleted response
**`Description`**
deletes a return reason
#### Defined in #### Defined in
[medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L48) [packages/medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L48)
___ ___
### list ### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-23.md#adminreturnreasonslistres)\> ▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-8.internal.md#adminreturnreasonslistres)\>
**`Description`**
Lists return reasons matching a query
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-23.md#adminreturnreasonslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-8.internal.md#adminreturnreasonslistres)\>
a list of return reasons matching the query. a list of return reasons matching the query.
**`Description`**
Lists return reasons matching a query
#### Defined in #### Defined in
[medusa-js/src/resources/admin/return-reasons.ts:75](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L75) [packages/medusa-js/src/resources/admin/return-reasons.ts:75](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L75)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
**`Description`**
retrieves a return reason
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the return reason to retrieve. | | `id` | `string` | id of the return reason to retrieve. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
the return reason with the given id the return reason with the given id
**`Description`**
retrieves a return reason
#### Defined in #### Defined in
[medusa-js/src/resources/admin/return-reasons.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L62) [packages/medusa-js/src/resources/admin/return-reasons.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L62)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
**`Description`**
Updates a return reason
#### Parameters #### Parameters
| 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-23.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | | `payload` | [`AdminPostReturnReasonsReasonReq`](internal-8.internal.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
the updated return reason. the updated return reason.
**`Description`**
Updates a return reason
#### Defined in #### Defined in
[medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L33) [packages/medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L33)
www/apps/docs/content/references/js-client/classes/AdminReturnsResource.md
+30 -26
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminReturnsResource # Class: AdminReturnsResource
## Hierarchy ## Hierarchy
@@ -10,80 +14,80 @@
### cancel ### cancel
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-24.md#adminreturnscancelres)\> ▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-8.internal.md#adminreturnscancelres)\>
**`Description`**
cancels a return
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of return to cancel | | `id` | `string` | id of return to cancel |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-24.md#adminreturnscancelres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-8.internal.md#adminreturnscancelres)\>
the order for which the return was canceled the order for which the return was canceled
**`Description`**
cancels a return
#### Defined in #### Defined in
[medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/returns.ts#L19) [packages/medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/returns.ts#L19)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-24.md#adminreturnslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-8.internal.md#adminreturnslistres)\>
**`Description`**
lists returns matching a query
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`AdminGetReturnsParams`](internal-24.AdminGetReturnsParams.md) | query for searching returns | | `query?` | [`AdminGetReturnsParams`](internal-8.internal.AdminGetReturnsParams.md) | query for searching returns |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-24.md#adminreturnslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-8.internal.md#adminreturnslistres)\>
a list of returns matching the query a list of returns matching the query
**`Description`**
lists returns matching a query
#### Defined in #### Defined in
[medusa-js/src/resources/admin/returns.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/returns.ts#L49) [packages/medusa-js/src/resources/admin/returns.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/returns.ts#L49)
___ ___
### receive ### receive
▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-24.md#adminreturnsres)\> ▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-8.internal.md#adminreturnsres)\>
**`Description`**
receive a return
#### Parameters #### Parameters
| 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-24.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | | `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-8.internal.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-24.md#adminreturnsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-8.internal.md#adminreturnsres)\>
the return the return
**`Description`**
receive a return
#### Defined in #### Defined in
[medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/returns.ts#L34) [packages/medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/returns.ts#L34)
www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.md
+125 -57
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminSalesChannelsResource # Class: AdminSalesChannelsResource
## Hierarchy ## Hierarchy
@@ -8,210 +12,274 @@
## Methods ## Methods
### addProducts ### addLocation
▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> ▸ **addLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
Add products to a sales channel Add a location 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.
To use this feature please enable featureflag `sales_channels` in your medusa backend project. To use this feature please enable featureflag `sales_channels` in your medusa backend project.
**`Description`**
Add products to a sales channel
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `salesChannelId` | `string` | | `salesChannelId` | `string` |
| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md) | | `payload` | [`AdminPostSalesChannelsChannelStockLocationsReq`](internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
a medusa sales channel the Medusa SalesChannel
**`Description`**
Add a stock location to a SalesChannel
#### Defined in #### Defined in
[medusa-js/src/resources/admin/sales-channels.ts:116](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L116) [packages/medusa-js/src/resources/admin/sales-channels.ts:134](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L134)
___
### addProducts
▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
Add products to a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag `sales_channels` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `salesChannelId` | `string` |
| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
a medusa sales channel
**`Description`**
Add products to a sales channel
#### Defined in
[packages/medusa-js/src/resources/admin/sales-channels.ts:118](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L118)
___ ___
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostSalesChannelsReq`](internal-25.AdminPostSalesChannelsReq.md) | | `payload` | [`AdminPostSalesChannelsReq`](internal-8.internal.AdminPostSalesChannelsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/sales-channels.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L34) [packages/medusa-js/src/resources/admin/sales-channels.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L36)
___ ___
### delete ### delete
▸ **delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
Delete a sales channel Delete 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.
To use this feature please enable featureflag `sales_channels` in your medusa backend project. To use this feature please enable featureflag `sales_channels` in your medusa backend project.
**`Description`**
gets a sales channel
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `salesChannelId` | `string` | | `salesChannelId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
an deletion result an deletion result
**`Description`**
gets a sales channel
#### Defined in #### Defined in
[medusa-js/src/resources/admin/sales-channels.ts:85](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L85) [packages/medusa-js/src/resources/admin/sales-channels.ts:87](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L87)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-21.md#adminsaleschannelslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.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.
To use this feature please enable featureflag `sales_channels` in your medusa backend project. To use this feature please enable featureflag `sales_channels` in your medusa backend project.
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetSalesChannelsParams`](internal-8.internal.AdminGetSalesChannelsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\>
the list of sales channel as well as the pagination properties
**`Description`** **`Description`**
Retrieve a list of sales channels Retrieve a list of sales channels
#### Defined in
[packages/medusa-js/src/resources/admin/sales-channels.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L66)
___
### removeLocation
▸ **removeLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
remove a location from a sales channel
This feature is under development and may change in the future.
To use this feature please enable featureflag `sales_channels` in your medusa backend project.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetSalesChannelsParams`](internal-25.AdminGetSalesChannelsParams.md) | | `salesChannelId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `payload` | [`AdminDeleteSalesChannelsChannelStockLocationsReq`](internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-21.md#adminsaleschannelslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
the list of sales channel as well as the pagination properties an deletion result
**`Description`**
Remove a stock location from a SalesChannel
#### Defined in #### Defined in
[medusa-js/src/resources/admin/sales-channels.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L64) [packages/medusa-js/src/resources/admin/sales-channels.ts:150](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L150)
___ ___
### removeProducts ### removeProducts
▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> ▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.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.
To use this feature please enable featureflag `sales_channels` in your medusa backend project. To use this feature please enable featureflag `sales_channels` in your medusa backend project.
**`Description`**
Remove products from a sales channel
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `salesChannelId` | `string` | | `salesChannelId` | `string` |
| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md) | | `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
a medusa sales channel a medusa sales channel
**`Description`**
Remove products from a sales channel
#### Defined in #### Defined in
[medusa-js/src/resources/admin/sales-channels.ts:100](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L100) [packages/medusa-js/src/resources/admin/sales-channels.ts:102](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L102)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> ▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.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.
To use this feature please enable featureflag `sales_channels` in your medusa backend project. To use this feature please enable featureflag `sales_channels` in your medusa backend project.
**`Description`**
gets a sales channel
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `salesChannelId` | `string` | | `salesChannelId` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
a medusa sales channel a medusa sales channel
**`Description`**
gets a sales channel
#### Defined in #### Defined in
[medusa-js/src/resources/admin/sales-channels.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L22) [packages/medusa-js/src/resources/admin/sales-channels.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L24)
___ ___
### update ### update
▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> ▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.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.
To use this feature please enable featureflag `sales_channels` in your medusa backend project. To use this feature please enable featureflag `sales_channels` in your medusa backend project.
**`Description`**
updates a sales channel
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `salesChannelId` | `string` | | `salesChannelId` | `string` |
| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-25.AdminPostSalesChannelsSalesChannelReq.md) | | `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\>
the updated medusa sales channel the updated medusa sales channel
**`Description`**
updates a sales channel
#### Defined in #### Defined in
[medusa-js/src/resources/admin/sales-channels.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L48) [packages/medusa-js/src/resources/admin/sales-channels.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L50)
www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.md
+47 -43
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminShippingOptionsResource # Class: AdminShippingOptionsResource
## Hierarchy ## Hierarchy
@@ -10,134 +14,134 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
**`Description`**
creates a shipping option.
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostShippingOptionsReq`](internal-26.AdminPostShippingOptionsReq.md) | | `payload` | [`AdminPostShippingOptionsReq`](internal-8.internal.AdminPostShippingOptionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
created shipping option. created shipping option.
**`Description`**
creates a shipping option.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L20) [packages/medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L20)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
deletes a shipping option
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of shipping option to delete. | | `id` | `string` | id of shipping option to delete. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
deleted response deleted response
**`Description`**
deletes a shipping option
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L50) [packages/medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L50)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-26.md#adminshippingoptionslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-8.internal.md#adminshippingoptionslistres)\>
**`Description`**
lists shipping options matching a query
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`AdminGetShippingOptionsParams`](internal-26.AdminGetShippingOptionsParams.md) | query for searching shipping options | | `query?` | [`AdminGetShippingOptionsParams`](internal-8.internal.AdminGetShippingOptionsParams.md) | query for searching shipping options |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-26.md#adminshippingoptionslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-8.internal.md#adminshippingoptionslistres)\>
a list of shipping options matching the query. a list of shipping options matching the query.
**`Description`**
lists shipping options matching a query
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L78) [packages/medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L78)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
**`Description`**
get a shipping option
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the shipping option to retrieve. | | `id` | `string` | id of the shipping option to retrieve. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
the shipping option with the given id the shipping option with the given id
**`Description`**
get a shipping option
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L64) [packages/medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L64)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
**`Description`**
updates a shipping option
#### Parameters #### Parameters
| 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-26.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | | `payload` | [`AdminPostShippingOptionsOptionReq`](internal-8.internal.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
the updated shipping option. the updated shipping option.
**`Description`**
updates a shipping option
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L35) [packages/medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L35)
www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.md
+26 -22
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminShippingProfilesResource # Class: AdminShippingProfilesResource
## Hierarchy ## Hierarchy
@@ -10,103 +14,103 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostShippingProfilesReq`](internal-27.AdminPostShippingProfilesReq.md) | | `payload` | [`AdminPostShippingProfilesReq`](internal-8.internal.AdminPostShippingProfilesReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12) [packages/medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29) [packages/medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29)
___ ___
### list ### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-27.md#adminshippingprofileslistres)\> ▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-8.internal.md#adminshippingprofileslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-27.md#adminshippingprofileslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-8.internal.md#adminshippingprofileslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45) [packages/medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37) [packages/medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-27.AdminPostShippingProfilesProfileReq.md) | | `payload` | [`AdminPostShippingProfilesProfileReq`](internal-8.internal.AdminPostShippingProfilesProfileReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20) [packages/medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20)
www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.md
+165
View File
@@ -0,0 +1,165 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminStockLocationsResource
## Hierarchy
- `default`
↳ **`AdminStockLocationsResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\>
Create a Stock Location
This feature is under development and may change in the future.
To use this feature please install @medusajs/stock-location
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostStockLocationsReq`](internal-8.internal.AdminPostStockLocationsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\>
a medusa Stock Location
**`Description`**
gets a medusa Stock Location
#### Defined in
[packages/medusa-js/src/resources/admin/stock-locations.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L21)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.md#deleteresponse)\>
Delete a Stock Location
This feature is under development and may change in the future.
To use this feature please install @medusajs/stock-location
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.md#deleteresponse)\>
**`Description`**
deletes a Stock Location
#### Defined in
[packages/medusa-js/src/resources/admin/stock-locations.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L66)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsListRes`](../modules/internal-8.internal.md#adminstocklocationslistres)\>
Retrieve a list of Stock Locations
This feature is under development and may change in the future.
To use this feature please install @medusajs/stock-location
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetStockLocationsParams`](internal-8.internal.AdminGetStockLocationsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsListRes`](../modules/internal-8.internal.md#adminstocklocationslistres)\>
the list of Stock Locations as well as the pagination properties
**`Description`**
Retrieve a list of Stock Locations
#### Defined in
[packages/medusa-js/src/resources/admin/stock-locations.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L81)
___
### retrieve
▸ **retrieve**(`itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\>
Retrieve a Stock Location
This feature is under development and may change in the future.
To use this feature please install @medusajs/stock-location
#### Parameters
| Name | Type |
| :------ | :------ |
| `itemId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\>
a medusa Stock Location
**`Description`**
gets a medusa Stock Location
#### Defined in
[packages/medusa-js/src/resources/admin/stock-locations.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L36)
___
### update
▸ **update**(`stockLocationId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\>
Update a Stock Location
This feature is under development and may change in the future.
To use this feature please install @medusajs/stock-location
#### Parameters
| Name | Type |
| :------ | :------ |
| `stockLocationId` | `string` |
| `payload` | [`AdminPostStockLocationsLocationReq`](internal-8.internal.AdminPostStockLocationsLocationReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\>
the updated medusa Stock Location
**`Description`**
updates a Stock Location
#### Defined in
[packages/medusa-js/src/resources/admin/stock-locations.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L51)
www/apps/docs/content/references/js-client/classes/AdminStoresResource.md
+59 -55
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminStoresResource # Class: AdminStoresResource
## Hierarchy ## Hierarchy
@@ -10,157 +14,157 @@
### addCurrency ### addCurrency
▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> ▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
**`Description`**
adds a currency to the store.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `currency_code` | `string` | code of the currency to add | | `currency_code` | `string` | code of the currency to add |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
updated store. updated store.
**`Description`**
adds a currency to the store.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L31) [packages/medusa-js/src/resources/admin/store.ts:32](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L32)
___ ___
### deleteCurrency ### deleteCurrency
▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> ▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
**`Description`**
deletes a currency from the available store currencies
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `currency_code` | `string` | currency code of the currency to delete from the store. | | `currency_code` | `string` | currency code of the currency to delete from the store. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
updated store updated store
**`Description`**
deletes a currency from the available store currencies
#### Defined in #### Defined in
[medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L45) [packages/medusa-js/src/resources/admin/store.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L46)
___ ___
### listPaymentProviders ### listPaymentProviders
▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-28.md#adminpaymentproviderslist)\> ▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-8.internal.md#adminpaymentproviderslist)\>
**`Description`**
Lists the store's payment providers
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-28.md#adminpaymentproviderslist)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-8.internal.md#adminpaymentproviderslist)\>
a list of payment providers configured on the store a list of payment providers configured on the store
**`Description`**
Lists the store's payment providers
#### Defined in #### Defined in
[medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L68) [packages/medusa-js/src/resources/admin/store.ts:69](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L69)
___ ___
### listTaxProviders ### listTaxProviders
▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-28.md#admintaxproviderslist)\> ▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-8.internal.md#admintaxproviderslist)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-8.internal.md#admintaxproviderslist)\>
a list of payment providers configured on the store
**`Description`** **`Description`**
Lists the store's payment providers Lists the store's payment providers
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-28.md#admintaxproviderslist)\>
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/29135c051/packages/medusa-js/src/resources/admin/store.ts#L79) [packages/medusa-js/src/resources/admin/store.ts:80](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L80)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> ▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminExtendedStoresRes`](../modules/internal-8.internal.md#adminextendedstoresres)\>
**`Description`**
gets a medusa store
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminExtendedStoresRes`](../modules/internal-8.internal.md#adminextendedstoresres)\>
a medusa store a medusa store
**`Description`**
gets a medusa store
#### Defined in #### Defined in
[medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L57) [packages/medusa-js/src/resources/admin/store.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L58)
___ ___
### update ### update
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> ▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
**`Description`**
Updates the store
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`AdminPostStoreReq`](internal-28.AdminPostStoreReq.md) | update to apply to the store. | | `payload` | [`AdminPostStoreReq`](internal-8.internal.AdminPostStoreReq.md) | update to apply to the store. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
the updated store. the updated store.
**`Description`**
Updates the store
#### Defined in #### Defined in
[medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L17) [packages/medusa-js/src/resources/admin/store.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L18)
www/apps/docs/content/references/js-client/classes/AdminSwapsResource.md
+13 -9
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminSwapsResource # Class: AdminSwapsResource
## Hierarchy ## Hierarchy
@@ -10,40 +14,40 @@
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-29.md#adminswapslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-8.internal.md#adminswapslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetSwapsParams`](internal-29.AdminGetSwapsParams.md) | | `query?` | [`AdminGetSwapsParams`](internal-8.internal.AdminGetSwapsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-29.md#adminswapslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-8.internal.md#adminswapslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/swaps.ts#L19) [packages/medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/swaps.ts#L19)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-29.md#adminswapsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-8.internal.md#adminswapsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-29.md#adminswapsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-8.internal.md#adminswapsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/swaps.ts#L11) [packages/medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/swaps.ts#L11)
www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.md
+66 -62
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminTaxRatesResource # Class: AdminTaxRatesResource
## Hierarchy ## Hierarchy
@@ -10,245 +14,245 @@
### addProductTypes ### addProductTypes
▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> ▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md) | | `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L100) [packages/medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-30.md#admintaxratesres)\> ▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-30.AdminPostTaxRatesTaxRateProductsReq.md) | | `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L84) [packages/medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-30.md#admintaxratesres)\> ▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | | `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L116) [packages/medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L116)
___ ___
### create ### create
▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> ▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostTaxRatesReq`](internal-30.AdminPostTaxRatesReq.md) | | `payload` | [`AdminPostTaxRatesReq`](internal-8.internal.AdminPostTaxRatesReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L53) [packages/medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L53)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L180) [packages/medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L180)
___ ___
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-30.md#admintaxrateslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-8.internal.md#admintaxrateslistres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`AdminGetTaxRatesParams`](internal-30.AdminGetTaxRatesParams.md) | | `query?` | [`AdminGetTaxRatesParams`](internal-8.internal.AdminGetTaxRatesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-30.md#admintaxrateslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-8.internal.md#admintaxrateslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L39) [packages/medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-30.md#admintaxratesres)\> ▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | | `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | | `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L148) [packages/medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-30.md#admintaxratesres)\> ▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md) | | `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md) | | `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L132) [packages/medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-30.md#admintaxratesres)\> ▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | | `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | | `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L164) [packages/medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L164)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> ▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L24) [packages/medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-30.md#admintaxratesres)\> ▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-30.AdminPostTaxRatesTaxRateReq.md) | | `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-8.internal.AdminPostTaxRatesTaxRateReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | | `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L68) [packages/medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L68)
www/apps/docs/content/references/js-client/classes/AdminUploadsResource.md
+58 -22
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminUploadsResource # Class: AdminUploadsResource
## Hierarchy ## Hierarchy
@@ -20,86 +24,118 @@
#### Defined in #### Defined in
[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L14) [packages/medusa-js/src/resources/admin/uploads.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L12)
## Methods ## Methods
### create ### \_createPayload
▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> ▸ `Private` **_createPayload**(`file`): `FormData`
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) | | `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> `FormData`
#### Defined in #### Defined in
[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L18) [packages/medusa-js/src/resources/admin/uploads.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L62)
___
### create
▸ **create**(`file`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-8.internal.md#adminuploadsres)\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) | File or array of files to upload. |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-8.internal.md#adminuploadsres)\>
Uploaded file or files.
**`Description`**
Uploads at least one file to the specific fileservice that is installed in Medusa.
#### Defined in
[packages/medusa-js/src/resources/admin/uploads.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L21)
___ ___
### createProtected ### createProtected
▸ **createProtected**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> ▸ **createProtected**(`file`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-8.internal.md#adminuploadsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type | Description |
| :------ | :------ | | :------ | :------ | :------ |
| `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) | | `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) | File or array of files to upload. |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-8.internal.md#adminuploadsres)\>
Uploaded file or files.
**`Description`**
Uploads at least one file with ACL or a non-public bucket to the specific fileservice that is installed in Medusa.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L27) [packages/medusa-js/src/resources/admin/uploads.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L34)
___ ___
### delete ### delete
▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminDeleteUploadsReq`](internal-31.AdminDeleteUploadsReq.md) | | `payload` | [`AdminDeleteUploadsReq`](internal-8.internal.AdminDeleteUploadsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L36) [packages/medusa-js/src/resources/admin/uploads.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L44)
___ ___
### getPresignedDownloadUrl ### getPresignedDownloadUrl
▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-31.md#adminuploadsdownloadurlres)\> ▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-8.internal.md#adminuploadsdownloadurlres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-31.AdminPostUploadsDownloadUrlReq.md) | | `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-8.internal.AdminPostUploadsDownloadUrlReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-31.md#adminuploadsdownloadurlres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-8.internal.md#adminuploadsdownloadurlres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/uploads.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L45) [packages/medusa-js/src/resources/admin/uploads.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L53)
www/apps/docs/content/references/js-client/classes/AdminUsersResource.md
+60 -56
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminUsersResource # Class: AdminUsersResource
## Hierarchy ## Hierarchy
@@ -10,112 +14,112 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
**`Description`**
creates a user with the provided information
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`AdminCreateUserPayload`](../modules/internal-32.md#admincreateuserpayload) | user creation request body | | `payload` | [`AdminCreateUserPayload`](../modules/internal-11.md#admincreateuserpayload) | user creation request body |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
created user created user
**`Description`**
creates a user with the provided information
#### Defined in #### Defined in
[medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L64) [packages/medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L64)
___ ___
### delete ### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> ▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
**`Description`**
deletes a user
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the user to be deleted | | `id` | `string` | id of the user to be deleted |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
delete response delete response
**`Description`**
deletes a user
#### Defined in #### Defined in
[medusa-js/src/resources/admin/users.ts:94](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L94) [packages/medusa-js/src/resources/admin/users.ts:94](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L94)
___ ___
### list ### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-32.md#adminuserslistres)\> ▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-8.internal.md#adminuserslistres)\>
**`Description`**
lists all users
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-32.md#adminuserslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-8.internal.md#adminuserslistres)\>
a list of all users a list of all users
**`Description`**
lists all users
#### Defined in #### Defined in
[medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L106) [packages/medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L106)
___ ___
### resetPassword ### resetPassword
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> ▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
**`Description`**
resets the users password given the correct token.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`AdminResetPasswordRequest`](internal-32.AdminResetPasswordRequest.md) | reset password information. | | `payload` | [`AdminResetPasswordRequest`](internal-8.internal.AdminResetPasswordRequest.md) | reset password information. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
**`Description`**
resets the users password given the correct token.
#### Defined in #### Defined in
[medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L36) [packages/medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L36)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
Retrieves a given user Retrieves a given user
@@ -124,67 +128,67 @@ Retrieves a given user
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the user | | `id` | `string` | id of the user |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
the user the user
#### Defined in #### Defined in
[medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L50) [packages/medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L50)
___ ___
### sendResetPasswordToken ### sendResetPasswordToken
▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> ▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
**`Description`**
resets password by re-sending password token.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`AdminResetPasswordTokenRequest`](internal-32.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. | | `payload` | [`AdminResetPasswordTokenRequest`](internal-8.internal.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
**`Description`**
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/29135c051/packages/medusa-js/src/resources/admin/users.ts#L22) [packages/medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L22)
___ ___
### update ### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> ▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
**`Description`**
updates a given user
#### Parameters #### Parameters
| 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-32.md#adminupdateuserpayload) | user update request body | | `payload` | [`AdminUpdateUserPayload`](../modules/internal-11.md#adminupdateuserpayload) | user update request body |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
the updated user the updated user
**`Description`**
updates a given user
#### Defined in #### Defined in
[medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L79) [packages/medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L79)
www/apps/docs/content/references/js-client/classes/AdminVariantsResource.md
+63 -8
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminVariantsResource # Class: AdminVariantsResource
## Hierarchy ## Hierarchy
@@ -8,21 +12,72 @@
## Methods ## Methods
### list ### getInventory
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-33.md#adminvariantslistres)\> ▸ **getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../modules/internal-8.internal.md#admingetvariantsvariantinventoryres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type | Description |
| :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`AdminGetVariantsParams`](internal-33.AdminGetVariantsParams.md) | | `variantId` | `string` | id of the variant to fetch inventory for |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-33.md#adminvariantslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../modules/internal-8.internal.md#admingetvariantsvariantinventoryres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/variants.ts#L7) [packages/medusa-js/src/resources/admin/variants.ts:60](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L60)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-8.internal.md#adminvariantslistres)\>
List product variants
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetVariantsParams`](internal-8.internal.AdminGetVariantsParams.md) | Query to filter variants by |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-8.internal.md#adminvariantslistres)\>
A list of variants satisfying the criteria of the query
#### Defined in
[packages/medusa-js/src/resources/admin/variants.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L19)
___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsRes`](../modules/internal-8.internal.md#adminvariantsres)\>
Get a product variant
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | Query to filter variants by |
| `query?` | [`AdminGetVariantParams`](internal-8.internal.AdminGetVariantParams.md) | - |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsRes`](../modules/internal-8.internal.md#adminvariantsres)\>
A list of variants satisfying the criteria of the query
#### Defined in
[packages/medusa-js/src/resources/admin/variants.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L39)
www/apps/docs/content/references/js-client/classes/AuthResource.md
+58 -29
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AuthResource # Class: AuthResource
## Hierarchy ## Hierarchy
@@ -10,97 +14,122 @@
### authenticate ### authenticate
▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> ▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\>
**`Description`**
Authenticates a customer using email and password combination
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`StorePostAuthReq`](internal-34.StorePostAuthReq.md) | authentication payload | | `payload` | [`StorePostAuthReq`](internal-8.internal.StorePostAuthReq.md) | authentication payload |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\>
**`Description`**
Authenticates a customer using email and password combination
#### Defined in #### Defined in
[medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/auth.ts#L16) [packages/medusa-js/src/resources/auth.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L18)
___ ___
### deleteSession ### deleteSession
▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> ▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
**`Description`**
Removes authentication session
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
**`Description`**
Removes authentication session
#### Defined in #### Defined in
[medusa-js/src/resources/auth.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/auth.ts#L25) [packages/medusa-js/src/resources/auth.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L27)
___ ___
### exists ### exists
▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-34.md#storegetauthemailres)\> ▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-8.internal.md#storegetauthemailres)\>
**`Description`**
Check if email exists
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `email` | `string` | is required | | `email` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-34.md#storegetauthemailres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-8.internal.md#storegetauthemailres)\>
**`Description`**
Check if email exists
#### Defined in #### Defined in
[medusa-js/src/resources/auth.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/auth.ts#L47) [packages/medusa-js/src/resources/auth.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L49)
___ ___
### getSession ### getSession
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> ▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\>
**`Description`** **`Description`**
Retrieves an authenticated session Retrieves an authenticated session
Usually used to check if authenticated session is alive. Usually used to check if authenticated session is alive.
#### Defined in
[packages/medusa-js/src/resources/auth.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L38)
___
### getToken
▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreBearerAuthRes`](../modules/internal-8.internal.md#storebearerauthres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `payload` | [`StorePostAuthReq`](internal-8.internal.StorePostAuthReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreBearerAuthRes`](../modules/internal-8.internal.md#storebearerauthres)\>
**`Description`**
Retrieves a new JWT access token
#### Defined in #### Defined in
[medusa-js/src/resources/auth.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/auth.ts#L36) [packages/medusa-js/src/resources/auth.ts:60](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L60)
www/apps/docs/content/references/js-client/classes/CartsResource.md
+55 -51
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: CartsResource # Class: CartsResource
## Hierarchy ## Hierarchy
@@ -14,13 +18,13 @@
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L15) [packages/medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-35.md#storecartsres)\> ▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Adds a shipping method to cart Adds a shipping method to cart
@@ -29,49 +33,49 @@ 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-35.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data | | `payload` | [`StorePostCartsCartShippingMethodReq`](internal-8.internal.StorePostCartsCartShippingMethodReq.md) | Contains id of shipping option and optional data |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L24) [packages/medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L24)
___ ___
### complete ### complete
▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-35.md#storecompletecartres)\> ▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-8.internal.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.
If payment is authorized and order is not yet created, we make sure to do so. If payment is authorized and order is not yet created, we make sure to do so.
The completion of a cart can be performed idempotently with a provided header Idempotency-Key. The completion of a cart can be performed idempotently with a provided header Idempotency-Key.
If not provuided, we will generate one for the request. If not provided, we will generate one for the request.
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-35.md#storecompletecartres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-8.internal.md#storecompletecartres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L43) [packages/medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L43)
___ ___
### create ### create
▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Creates a cart Creates a cart
@@ -79,22 +83,22 @@ Creates a cart
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `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 | | `payload?` | [`StorePostCartReq`](internal-8.internal.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`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L58) [packages/medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L58)
___ ___
### createPaymentSessions ### createPaymentSessions
▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.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.
@@ -105,21 +109,21 @@ This is usually called when a customer proceeds to checkout.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L74) [packages/medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L74)
___ ___
### deleteDiscount ### deleteDiscount
▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Removes a discount from cart. Removes a discount from cart.
@@ -129,21 +133,21 @@ Removes a discount from cart.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `code` | `string` | discount code to remove | | `code` | `string` | discount code to remove |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L89) [packages/medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L89)
___ ___
### deletePaymentSession ### deletePaymentSession
▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.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
@@ -154,21 +158,21 @@ Can be useful in case a payment has failed
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `provider_id` | `string` | the provider id of the session e.g. "stripe" | | `provider_id` | `string` | the provider id of the session e.g. "stripe" |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L106) [packages/medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L106)
___ ___
### refreshPaymentSession ### refreshPaymentSession
▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Refreshes a payment session. Refreshes a payment session.
@@ -178,21 +182,21 @@ Refreshes a payment session.
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `provider_id` | `string` | the provider id of the session e.g. "stripe" | | `provider_id` | `string` | the provider id of the session e.g. "stripe" |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L122) [packages/medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L122)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Retrieves a cart Retrieves a cart
@@ -201,21 +205,21 @@ Retrieves a cart
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L137) [packages/medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L137)
___ ___
### setPaymentSession ### setPaymentSession
▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Refreshes a payment session. Refreshes a payment session.
@@ -224,22 +228,22 @@ Refreshes a payment session.
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-35.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" | | `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-8.internal.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L152) [packages/medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L152)
___ ___
### update ### update
▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Updates a cart Updates a cart
@@ -248,22 +252,22 @@ Updates a cart
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `payload` | [`StorePostCartsCartReq`](internal-35.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address | | `payload` | [`StorePostCartsCartReq`](internal-8.internal.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L168) [packages/medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-35.md#storecartsres)\> ▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Updates the payment method Updates the payment method
@@ -273,13 +277,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-35.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | | `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md) | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L185) [packages/medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L185)
www/apps/docs/content/references/js-client/classes/CollectionsResource.md
+21 -17
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: CollectionsResource # Class: CollectionsResource
## Hierarchy ## Hierarchy
@@ -10,48 +14,48 @@
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-36.md#storecollectionslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-8.internal.md#storecollectionslistres)\>
**`Description`**
Retrieves a list of collections
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`StoreGetCollectionsParams`](internal-36.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list | | `query?` | [`StoreGetCollectionsParams`](internal-8.internal.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-36.md#storecollectionslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-8.internal.md#storecollectionslistres)\>
**`Description`**
Retrieves a list of collections
#### Defined in #### Defined in
[medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/collections.ts#L28) [packages/medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/collections.ts#L28)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-36.md#storecollectionsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-8.internal.md#storecollectionsres)\>
**`Description`**
Retrieves a single collection
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | id of the collection | | `id` | `string` | id of the collection |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-36.md#storecollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-8.internal.md#storecollectionsres)\>
**`Description`**
Retrieves a single collection
#### Defined in #### Defined in
[medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/collections.ts#L17) [packages/medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/collections.ts#L17)
www/apps/docs/content/references/js-client/classes/CustomerResource.md
+35 -31
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: CustomerResource # Class: CustomerResource
## Hierarchy ## Hierarchy
@@ -14,7 +18,7 @@
#### Defined in #### Defined in
[medusa-js/src/resources/customers.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L18) [packages/medusa-js/src/resources/customers.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L18)
___ ___
@@ -24,13 +28,13 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L17) [packages/medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L17)
## Methods ## Methods
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
Creates a customer Creates a customer
@@ -38,22 +42,22 @@ Creates a customer
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`StorePostCustomersReq`](internal-37.StorePostCustomersReq.md) | information of customer | | `payload` | [`StorePostCustomersReq`](internal-8.internal.StorePostCustomersReq.md) | information of customer |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/customers.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L26) [packages/medusa-js/src/resources/customers.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L26)
___ ___
### generatePasswordToken ### generatePasswordToken
▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> ▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
Generates a reset password token, which can be used to reset the password. Generates a reset password token, which can be used to reset the password.
The token is not returned but should be sent out to the customer in an email. The token is not returned but should be sent out to the customer in an email.
@@ -62,22 +66,22 @@ 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-37.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token | | `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)
#### Defined in #### Defined in
[medusa-js/src/resources/customers.ts:101](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L101) [packages/medusa-js/src/resources/customers.ts:101](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L101)
___ ___
### listOrders ### listOrders
▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-37.md#storecustomerslistordersres)\> ▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-8.internal.md#storecustomerslistordersres)\>
Retrieve customer orders Retrieve customer orders
@@ -85,22 +89,22 @@ Retrieve customer orders
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-37.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | | `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-8.internal.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-37.md#storecustomerslistordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-8.internal.md#storecustomerslistordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/customers.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L66) [packages/medusa-js/src/resources/customers.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L66)
___ ___
### resetPassword ### resetPassword
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> ▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
Resets customer password Resets customer password
@@ -108,22 +112,22 @@ Resets customer password
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`StorePostCustomersResetPasswordReq`](internal-37.StorePostCustomersResetPasswordReq.md) | info used to reset customer password | | `payload` | [`StorePostCustomersResetPasswordReq`](internal-8.internal.StorePostCustomersResetPasswordReq.md) | info used to reset customer password |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/customers.ts:86](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L86) [packages/medusa-js/src/resources/customers.ts:86](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L86)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> ▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
Retrieves the customer that is currently logged Retrieves the customer that is currently logged
@@ -131,21 +135,21 @@ Retrieves the customer that is currently logged
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/customers.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L39) [packages/medusa-js/src/resources/customers.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L39)
___ ___
### update ### update
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> ▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
Updates a customer Updates a customer
@@ -153,13 +157,13 @@ Updates a customer
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerReq`](internal-37.StorePostCustomersCustomerReq.md) | information to update customer with | | `payload` | [`StorePostCustomersCustomerReq`](internal-8.internal.StorePostCustomersCustomerReq.md) | information to update customer with |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/customers.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L52) [packages/medusa-js/src/resources/customers.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L52)
www/apps/docs/content/references/js-client/classes/GiftCardsResource.md
+12 -8
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: GiftCardsResource # Class: GiftCardsResource
## Hierarchy ## Hierarchy
@@ -10,23 +14,23 @@
### retrieve ### retrieve
▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-38.md#storegiftcardsres)\> ▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-8.internal.md#storegiftcardsres)\>
**`Description`**
Retrieves a single GiftCard
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `code` | `string` | code of the gift card | | `code` | `string` | code of the gift card |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-38.md#storegiftcardsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-8.internal.md#storegiftcardsres)\>
**`Description`**
Retrieves a single GiftCard
#### Defined in #### Defined in
[medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/gift-cards.ts#L12) [packages/medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/gift-cards.ts#L12)
www/apps/docs/content/references/js-client/classes/LineItemsResource.md
+18 -14
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: LineItemsResource # Class: LineItemsResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,7 @@
### create ### create
▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> ▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Creates a line-item for a cart Creates a line-item for a cart
@@ -19,22 +23,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-39.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item | | `payload` | [`StorePostCartsCartLineItemsReq`](internal-8.internal.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/line-items.ts#L17) [packages/medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-35.md#storecartsres)\> ▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Remove a line-item from a cart Remove a line-item from a cart
@@ -44,21 +48,21 @@ Remove a line-item from a cart
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | id of cart | | `cart_id` | `string` | id of cart |
| `line_id` | `string` | id of item to remove | | `line_id` | `string` | id of item to remove |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/line-items.ts#L50) [packages/medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/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-35.md#storecartsres)\> ▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
Updates a line-item. Updates a line-item.
Only quantity updates are allowed Only quantity updates are allowed
@@ -69,13 +73,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-39.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item | | `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-8.internal.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/line-items.ts#L34) [packages/medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/line-items.ts#L34)
www/apps/docs/content/references/js-client/classes/OrderEditsResource.md
+13 -9
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: OrderEditsResource # Class: OrderEditsResource
## Hierarchy ## Hierarchy
@@ -17,7 +21,7 @@
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
@@ -25,7 +29,7 @@
#### Defined in #### Defined in
[medusa-js/src/resources/order-edits.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/order-edits.ts#L26) [packages/medusa-js/src/resources/order-edits.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/order-edits.ts#L26)
___ ___
@@ -38,8 +42,8 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-40.StorePostOrderEditsOrderEditDecline.md) | | `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-8.internal.StorePostOrderEditsOrderEditDecline.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
@@ -47,25 +51,25 @@ ___
#### Defined in #### Defined in
[medusa-js/src/resources/order-edits.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/order-edits.ts#L17) [packages/medusa-js/src/resources/order-edits.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/order-edits.ts#L17)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-40.md#storeordereditsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-8.internal.md#storeordereditsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-40.md#storeordereditsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-8.internal.md#storeordereditsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/order-edits.ts:9](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/order-edits.ts#L9) [packages/medusa-js/src/resources/order-edits.ts:9](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/order-edits.ts#L9)
www/apps/docs/content/references/js-client/classes/OrdersResource.md
+55 -51
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: OrdersResource # Class: OrdersResource
## Hierarchy ## Hierarchy
@@ -10,123 +14,123 @@
### confirmRequest ### confirmRequest
▸ **confirmRequest**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> ▸ **confirmRequest**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerAcceptClaimReq`](internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md) | signed token to grant access |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)
**`Description`** **`Description`**
Grant access to a list of orders Grant access to a list of orders
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerAcceptClaimReq`](internal-41.StorePostCustomersCustomerAcceptClaimReq.md) | signed token to grant access |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Defined in #### Defined in
[medusa-js/src/resources/orders.ts:78](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L78) [packages/medusa-js/src/resources/orders.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L78)
___ ___
### lookupOrder ### lookupOrder
▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> ▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StoreGetOrdersParams`](internal-8.internal.StoreGetOrdersParams.md) | details used to look up the order |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\>
**`Description`** **`Description`**
Look up an order using order details Look up an order using order details
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StoreGetOrdersParams`](internal-41.StoreGetOrdersParams.md) | details used to look up the order |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/orders.ts:46](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L46) [packages/medusa-js/src/resources/orders.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L46)
___ ___
### requestCustomerOrders ### requestCustomerOrders
▸ **requestCustomerOrders**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> ▸ **requestCustomerOrders**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
**`Description`**
Request access to a list of orders
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerOrderClaimReq`](internal-41.StorePostCustomersCustomerOrderClaimReq.md) | display ids of orders to request | | `payload` | [`StorePostCustomersCustomerOrderClaimReq`](internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md) | display ids of orders to request |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)
**`Description`**
Request access to a list of orders
#### Defined in #### Defined in
[medusa-js/src/resources/orders.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L64) [packages/medusa-js/src/resources/orders.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L64)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\>
**`Description`**
Retrieves an order
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | is required | | `id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\>
**`Description`**
Retrieves an order
#### Defined in #### Defined in
[medusa-js/src/resources/orders.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L18) [packages/medusa-js/src/resources/orders.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L18)
___ ___
### retrieveByCartId ### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> ▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\>
**`Description`**
Retrieves an order by cart id
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | is required | | `cart_id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\>
**`Description`**
Retrieves an order by cart id
#### Defined in #### Defined in
[medusa-js/src/resources/orders.ts:32](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L32) [packages/medusa-js/src/resources/orders.ts:32](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L32)
www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.md
+32 -28
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: PaymentCollectionsResource # Class: PaymentCollectionsResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,7 @@
### authorizePaymentSession ### authorizePaymentSession
▸ **authorizePaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> ▸ **authorizePaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Parameters #### Parameters
@@ -18,87 +22,87 @@
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `session_id` | `string` | | `session_id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/payment-collections.ts:29](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L29) [packages/medusa-js/src/resources/payment-collections.ts:29](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L29)
___ ___
### authorizePaymentSessionsBatch ### authorizePaymentSessionsBatch
▸ **authorizePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> ▸ **authorizePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`StorePostPaymentCollectionsBatchSessionsAuthorizeReq`](internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) | | `payload` | [`StorePostPaymentCollectionsBatchSessionsAuthorizeReq`](internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/payment-collections.ts:38](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L38) [packages/medusa-js/src/resources/payment-collections.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L38)
___ ___
### managePaymentSession ### managePaymentSession
▸ **managePaymentSession**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> ▸ **managePaymentSession**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`StorePaymentCollectionSessionsReq`](internal-42.StorePaymentCollectionSessionsReq.md) | | `payload` | [`StorePaymentCollectionSessionsReq`](internal-8.internal.StorePaymentCollectionSessionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/payment-collections.ts:56](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L56) [packages/medusa-js/src/resources/payment-collections.ts:56](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L56)
___ ___
### managePaymentSessionsBatch ### managePaymentSessionsBatch
▸ **managePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> ▸ **managePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `payload` | [`StorePostPaymentCollectionsBatchSessionsReq`](internal-42.StorePostPaymentCollectionsBatchSessionsReq.md) | | `payload` | [`StorePostPaymentCollectionsBatchSessionsReq`](internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/payment-collections.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L47) [packages/medusa-js/src/resources/payment-collections.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L47)
___ ___
### refreshPaymentSession ### refreshPaymentSession
▸ **refreshPaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-42.md#storepaymentcollectionssessionres)\> ▸ **refreshPaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-8.internal.md#storepaymentcollectionssessionres)\>
#### Parameters #### Parameters
@@ -106,34 +110,34 @@ ___
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `session_id` | `string` | | `session_id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-42.md#storepaymentcollectionssessionres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-8.internal.md#storepaymentcollectionssessionres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/payment-collections.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L65) [packages/medusa-js/src/resources/payment-collections.ts:65](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L65)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> ▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `id` | `string` | | `id` | `string` |
| `query?` | [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) | | `query?` | [`StoreGetPaymentCollectionsParams`](internal-8.internal.StoreGetPaymentCollectionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/payment-collections.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L14) [packages/medusa-js/src/resources/payment-collections.ts:14](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L14)
www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.md
+8 -4
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: PaymentMethodsResource # Class: PaymentMethodsResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,7 @@
### list ### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-43.md#storecustomerslistpaymentmethodsres)\> ▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-8.internal.md#storecustomerslistpaymentmethodsres)\>
Lists customer payment methods Lists customer payment methods
@@ -18,12 +22,12 @@ Lists customer payment methods
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-43.md#storecustomerslistpaymentmethodsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-8.internal.md#storecustomerslistpaymentmethodsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-methods.ts#L12) [packages/medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-methods.ts#L12)
www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.md
+62
View File
@@ -0,0 +1,62 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ProductCategoriesResource
## Hierarchy
- `default`
↳ **`ProductCategoriesResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetProductCategoriesRes`](../modules/internal-8.internal.md#storegetproductcategoriesres)\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`StoreGetProductCategoriesParams`](internal-8.internal.StoreGetProductCategoriesParams.md) | is optional. Can contain a limit and offset for the returned list |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetProductCategoriesRes`](../modules/internal-8.internal.md#storegetproductcategoriesres)\>
**`Description`**
Retrieves a list of product categories
#### Defined in
[packages/medusa-js/src/resources/product-categories.ts:40](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-categories.ts#L40)
___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetProductCategoriesCategoryRes`](../modules/internal-8.internal.md#storegetproductcategoriescategoryres)\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the product category |
| `query?` | [`StoreGetProductCategoriesCategoryParams`](internal-8.internal.StoreGetProductCategoriesCategoryParams.md) | is optional. Can contain a fields or relations for the returned list |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetProductCategoriesCategoryRes`](../modules/internal-8.internal.md#storegetproductcategoriescategoryres)\>
**`Description`**
Retrieves a single product category
#### Defined in
[packages/medusa-js/src/resources/product-categories.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-categories.ts#L19)
www/apps/docs/content/references/js-client/classes/ProductTagsResource.md
+36
View File
@@ -0,0 +1,36 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ProductTagsResource
## Hierarchy
- `default`
↳ **`ProductTagsResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTagsListRes`](../modules/internal-8.internal.md#storeproducttagslistres)\>
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`StoreGetProductTagsParams`](internal-8.internal.StoreGetProductTagsParams.md) | is optional. Can contain a limit and offset for the returned list |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTagsListRes`](../modules/internal-8.internal.md#storeproducttagslistres)\>
**`Description`**
Retrieves a list of product tags
#### Defined in
[packages/medusa-js/src/resources/product-tags.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-tags.ts#L16)
www/apps/docs/content/references/js-client/classes/ProductTypesResource.md
+13 -9
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ProductTypesResource # Class: ProductTypesResource
## Hierarchy ## Hierarchy
@@ -10,23 +14,23 @@
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-44.md#storeproducttypeslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-8.internal.md#storeproducttypeslistres)\>
**`Description`**
Retrieves a list of product types
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`StoreGetProductTypesParams`](internal-44.StoreGetProductTypesParams.md) | is optional. Can contain a limit and offset for the returned list | | `query?` | [`StoreGetProductTypesParams`](internal-8.internal.StoreGetProductTypesParams.md) | is optional. Can contain a limit and offset for the returned list |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-44.md#storeproducttypeslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-8.internal.md#storeproducttypeslistres)\>
**`Description`**
Retrieves a list of product types
#### Defined in #### Defined in
[medusa-js/src/resources/product-types.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/product-types.ts#L16) [packages/medusa-js/src/resources/product-types.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-types.ts#L16)
www/apps/docs/content/references/js-client/classes/ProductVariantsResource.md
+21 -17
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ProductVariantsResource # Class: ProductVariantsResource
## Hierarchy ## Hierarchy
@@ -10,48 +14,48 @@
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-45.md#storevariantslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-8.internal.md#storevariantslistres)\>
**`Description`**
Retrieves a list of of Product Variants
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`StoreGetVariantsParams`](internal-45.StoreGetVariantsParams.md) | | `query?` | [`StoreGetVariantsParams`](internal-8.internal.StoreGetVariantsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-45.md#storevariantslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-8.internal.md#storevariantslistres)\>
**`Description`**
Retrieves a list of of Product Variants
#### Defined in #### Defined in
[medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/product-variants.ts#L28) [packages/medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-variants.ts#L28)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-45.md#storevariantsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-8.internal.md#storevariantsres)\>
**`Description`**
Retrieves a single product variant
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | is required | | `id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-45.md#storevariantsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-8.internal.md#storevariantsres)\>
**`Description`**
Retrieves a single product variant
#### Defined in #### Defined in
[medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/product-variants.ts#L17) [packages/medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-variants.ts#L17)
www/apps/docs/content/references/js-client/classes/ProductsResource.md
+31 -27
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ProductsResource # Class: ProductsResource
## Hierarchy ## Hierarchy
@@ -14,79 +18,79 @@
#### Defined in #### Defined in
[medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/products.ts#L14) [packages/medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/products.ts#L14)
## Methods ## Methods
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-46.md#storeproductslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-8.internal.md#storeproductslistres)\>
**`Description`**
Retrieves a list of products
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `query?` | [`StoreGetProductsParams`](internal-46.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list | | `query?` | [`StoreGetProductsParams`](internal-8.internal.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-46.md#storeproductslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-8.internal.md#storeproductslistres)\>
**`Description`**
Retrieves a list of products
#### Defined in #### Defined in
[medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/products.ts#L50) [packages/medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/products.ts#L50)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-46.md#storeproductsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsRes`](../modules/internal-8.internal.md#storeproductsres)\>
**`Description`**
Retrieves a single Product
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | is required | | `id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-46.md#storeproductsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsRes`](../modules/internal-8.internal.md#storeproductsres)\>
**`Description`**
Retrieves a single Product
#### Defined in #### Defined in
[medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/products.ts#L22) [packages/medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/products.ts#L22)
___ ___
### search ### search
▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-46.md#storepostsearchres)\> ▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-8.internal.md#storepostsearchres)\>
**`Description`**
Searches for products
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `searchOptions` | [`StorePostSearchReq`](internal-46.StorePostSearchReq.md) | is required | | `searchOptions` | [`StorePostSearchReq`](internal-8.internal.StorePostSearchReq.md) | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-46.md#storepostsearchres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-8.internal.md#storepostsearchres)\>
**`Description`**
Searches for products
#### Defined in #### Defined in
[medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/products.ts#L36) [packages/medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/products.ts#L36)
www/apps/docs/content/references/js-client/classes/RegionsResource.md
+20 -16
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: RegionsResource # Class: RegionsResource
## Hierarchy ## Hierarchy
@@ -10,47 +14,47 @@
### list ### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-47.md#storeregionslistres)\> ▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-8.internal.md#storeregionslistres)\>
**`Description`**
Retrieves a list of regions
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-47.md#storeregionslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-8.internal.md#storeregionslistres)\>
**`Description`**
Retrieves a list of regions
#### Defined in #### Defined in
[medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/regions.ts#L11) [packages/medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/regions.ts#L11)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-47.md#storeregionsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-8.internal.md#storeregionsres)\>
**`Description`**
Retrieves a region
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | is required | | `id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-47.md#storeregionsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-8.internal.md#storeregionsres)\>
**`Description`**
Retrieves a region
#### Defined in #### Defined in
[medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/regions.ts#L22) [packages/medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/regions.ts#L22)
www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.md
+16 -12
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ReturnReasonsResource # Class: ReturnReasonsResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,7 @@
### list ### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-48.md#storereturnreasonslistres)\> ▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-8.internal.md#storereturnreasonslistres)\>
Lists return reasons defined in Medusa Admin Lists return reasons defined in Medusa Admin
@@ -18,37 +22,37 @@ Lists return reasons defined in Medusa Admin
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-48.md#storereturnreasonslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-8.internal.md#storereturnreasonslistres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/return-reasons.ts#L25) [packages/medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/return-reasons.ts#L25)
___ ___
### retrieve ### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-48.md#storereturnreasonsres)\> ▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-8.internal.md#storereturnreasonsres)\>
**`Description`**
Retrieves a single Return Reason
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `id` | `string` | is required | | `id` | `string` | is required |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-48.md#storereturnreasonsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-8.internal.md#storereturnreasonsres)\>
**`Description`**
Retrieves a single Return Reason
#### Defined in #### Defined in
[medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/return-reasons.ts#L15) [packages/medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/return-reasons.ts#L15)
www/apps/docs/content/references/js-client/classes/ReturnsResource.md
+9 -5
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ReturnsResource # Class: ReturnsResource
## Hierarchy ## Hierarchy
@@ -10,7 +14,7 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-49.md#storereturnsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-8.internal.md#storereturnsres)\>
Creates a return request Creates a return request
@@ -18,13 +22,13 @@ Creates a return request
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `payload` | [`StorePostReturnsReq`](internal-49.StorePostReturnsReq.md) | details needed to create a return | | `payload` | [`StorePostReturnsReq`](internal-8.internal.StorePostReturnsReq.md) | details needed to create a return |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-49.md#storereturnsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-8.internal.md#storereturnsres)\>
#### Defined in #### Defined in
[medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/returns.ts#L12) [packages/medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/returns.ts#L12)
www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.md
+21 -17
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: ShippingOptionsResource # Class: ShippingOptionsResource
## Hierarchy ## Hierarchy
@@ -10,48 +14,48 @@
### list ### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> ▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\>
**`Description`**
Lists shiping options available
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `query?` | [`StoreGetShippingOptionsParams`](internal-50.StoreGetShippingOptionsParams.md) | | `query?` | [`StoreGetShippingOptionsParams`](internal-8.internal.StoreGetShippingOptionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\>
**`Description`**
Lists shipping options available
#### Defined in #### Defined in
[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/shipping-options.ts#L27) [packages/medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/shipping-options.ts#L27)
___ ___
### listCartOptions ### listCartOptions
▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> ▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\>
**`Description`**
Lists shiping options available for a cart
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `cart_id` | `string` | | `cart_id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\>
**`Description`**
Lists shipping options available for a cart
#### Defined in #### Defined in
[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/shipping-options.ts#L16) [packages/medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/shipping-options.ts#L16)
www/apps/docs/content/references/js-client/classes/SwapsResource.md
+21 -17
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: SwapsResource # Class: SwapsResource
## Hierarchy ## Hierarchy
@@ -10,48 +14,48 @@
### create ### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> ▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
**`Description`**
Creates a swap from a cart
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `payload` | [`StorePostSwapsReq`](internal-51.StorePostSwapsReq.md) | | `payload` | [`StorePostSwapsReq`](internal-8.internal.StorePostSwapsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
**`Description`**
Creates a swap from a cart
#### Defined in #### Defined in
[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/swaps.ts#L12) [packages/medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/swaps.ts#L12)
___ ___
### retrieveByCartId ### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> ▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
**`Description`**
Retrieves a swap by cart id
#### Parameters #### Parameters
| Name | Type | Description | | Name | Type | Description |
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `cart_id` | `string` | id of cart | | `cart_id` | `string` | id of cart |
| `customHeaders` | `Record`<`string`, `any`\> | | | `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns #### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
**`Description`**
Retrieves a swap by cart id
#### Defined in #### Defined in
[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/swaps.ts#L23) [packages/medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/swaps.ts#L23)
www/apps/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md
+23 -2
View File
@@ -1,7 +1,28 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostAuthReq # Class: AdminPostAuthReq
[internal](../modules/internal-1.md).AdminPostAuthReq [internal](../modules/internal-1.md).AdminPostAuthReq
**`Schema`**
AdminPostAuthReq
type: object
required:
- email
- password
properties:
email:
type: string
description: The user's email.
format: email
password:
type: string
description: The user's password.
format: password
## Properties ## Properties
### email ### email
@@ -10,7 +31,7 @@
#### Defined in #### Defined in
medusa/dist/api/routes/admin/auth/create-session.d.ts:76 packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:78
___ ___
@@ -20,4 +41,4 @@ ___
#### Defined in #### Defined in
medusa/dist/api/routes/admin/auth/create-session.d.ts:77 packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:79
www/apps/docs/content/references/js-client/classes/internal-1.BaseEntity.md
+75
View File
@@ -0,0 +1,75 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: BaseEntity
[internal](../modules/internal-1.md).BaseEntity
Base abstract entity for all entities
## Hierarchy
- **`BaseEntity`**
↳ [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md)
↳ [`ProductCategory`](internal-3.ProductCategory.md)
↳ [`TaxRate`](internal-3.TaxRate.md)
↳ [`Order`](internal-3.Order.md)
↳ [`Payment`](internal-3.Payment.md)
↳ [`Fulfillment`](internal-3.Fulfillment.md)
↳ [`Return`](internal-3.Return.md)
↳ [`Refund`](internal-3.Refund.md)
↳ [`DraftOrder`](internal-3.DraftOrder.md)
↳ [`OrderEdit`](internal-3.OrderEdit.md)
↳ [`LineItem`](internal-3.LineItem.md)
↳ [`PaymentSession`](internal-3.PaymentSession.md)
↳ [`TaxLine`](internal-3.TaxLine.md)
↳ [`Notification`](internal-8.internal.Notification.md)
↳ [`PublishableApiKey`](internal-8.internal.PublishableApiKey.md)
↳ [`Store`](internal-8.internal.Store.md)
## Properties
### created\_at
• **created\_at**: `Date`
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:6
___
### id
• **id**: `string`
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:5
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:7
www/apps/docs/content/references/js-client/classes/internal-1.SoftDeletableEntity.md
+147
View File
@@ -0,0 +1,147 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: SoftDeletableEntity
[internal](../modules/internal-1.md).SoftDeletableEntity
Base abstract entity for all entities
## Hierarchy
- [`BaseEntity`](internal-1.BaseEntity.md)
↳ **`SoftDeletableEntity`**
↳↳ [`User`](internal-1.User.md)
↳↳ [`BatchJob`](internal-2.BatchJob.md)
↳↳ [`ProductCollection`](internal-3.ProductCollection.md)
↳↳ [`Product`](internal-3.Product.md)
↳↳ [`Image`](internal-3.Image.md)
↳↳ [`ProductOption`](internal-3.ProductOption.md)
↳↳ [`ProductVariant`](internal-3.ProductVariant.md)
↳↳ [`ShippingProfile`](internal-3.ShippingProfile.md)
↳↳ [`ProductType`](internal-3.ProductType.md)
↳↳ [`ProductTag`](internal-3.ProductTag.md)
↳↳ [`SalesChannel`](internal-3.SalesChannel.md)
↳↳ [`ProductOptionValue`](internal-3.ProductOptionValue.md)
↳↳ [`MoneyAmount`](internal-3.MoneyAmount.md)
↳↳ [`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)
↳↳ [`ShippingOption`](internal-3.ShippingOption.md)
↳↳ [`SalesChannelLocation`](internal-3.SalesChannelLocation.md)
↳↳ [`PriceList`](internal-3.PriceList.md)
↳↳ [`Region`](internal-3.Region.md)
↳↳ [`CustomerGroup`](internal-3.CustomerGroup.md)
↳↳ [`Customer`](internal-3.Customer.md)
↳↳ [`Address`](internal-3.Address.md)
↳↳ [`Cart`](internal-3.Cart.md)
↳↳ [`Discount`](internal-3.Discount.md)
↳↳ [`GiftCard`](internal-3.GiftCard.md)
↳↳ [`ClaimOrder`](internal-3.ClaimOrder.md)
↳↳ [`Swap`](internal-3.Swap.md)
↳↳ [`DiscountRule`](internal-3.DiscountRule.md)
↳↳ [`TrackingLink`](internal-3.TrackingLink.md)
↳↳ [`ClaimItem`](internal-3.ClaimItem.md)
↳↳ [`OrderItemChange`](internal-3.OrderItemChange.md)
↳↳ [`PaymentCollection`](internal-3.PaymentCollection.md)
↳↳ [`DiscountCondition`](internal-3.DiscountCondition.md)
↳↳ [`ReturnReason`](internal-3.ReturnReason.md)
↳↳ [`ClaimImage`](internal-3.ClaimImage.md)
↳↳ [`ClaimTag`](internal-3.ClaimTag.md)
↳↳ [`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md)
↳↳ [`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)
↳↳ [`Invite`](internal-8.internal.Invite.md)
↳↳ [`Note`](internal-8.internal.Note.md)
↳↳ [`ProductVariantMoneyAmount`](internal-8.internal.ProductVariantMoneyAmount.md)
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at)
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:6
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Defined in
packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
___
### id
• **id**: `string`
#### Inherited from
[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id)
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:5
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at)
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:7
www/apps/docs/content/references/js-client/classes/internal-1.User.md
+22 -18
View File
@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: User # Class: User
[internal](../modules/internal-1.md).User [internal](../modules/internal-1.md).User
@@ -6,7 +10,7 @@ Base abstract entity for all entities
## Hierarchy ## Hierarchy
- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md)
↳ **`User`** ↳ **`User`**
@@ -18,7 +22,7 @@ Base abstract entity for all entities
#### Defined in #### Defined in
medusa/dist/models/user.d.ts:13 packages/medusa/dist/models/user.d.ts:13
___ ___
@@ -28,7 +32,7 @@ ___
#### Defined in #### Defined in
medusa/dist/models/user.d.ts:15 packages/medusa/dist/models/user.d.ts:15
___ ___
@@ -38,11 +42,11 @@ ___
#### Inherited from #### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) [SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at)
#### Defined in #### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:6 packages/medusa/dist/interfaces/models/base-entity.d.ts:6
___ ___
@@ -52,11 +56,11 @@ ___
#### Inherited from #### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) [SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at)
#### Defined in #### Defined in
medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
___ ___
@@ -66,7 +70,7 @@ ___
#### Defined in #### Defined in
medusa/dist/models/user.d.ts:9 packages/medusa/dist/models/user.d.ts:9
___ ___
@@ -76,7 +80,7 @@ ___
#### Defined in #### Defined in
medusa/dist/models/user.d.ts:10 packages/medusa/dist/models/user.d.ts:10
___ ___
@@ -86,11 +90,11 @@ ___
#### Inherited from #### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) [SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id)
#### Defined in #### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:5 packages/medusa/dist/interfaces/models/base-entity.d.ts:5
___ ___
@@ -100,17 +104,17 @@ ___
#### Defined in #### Defined in
medusa/dist/models/user.d.ts:11 packages/medusa/dist/models/user.d.ts:11
___ ___
### metadata ### metadata
• **metadata**: `Record`<`string`, `unknown`\> • **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
#### Defined in #### Defined in
medusa/dist/models/user.d.ts:14 packages/medusa/dist/models/user.d.ts:14
___ ___
@@ -120,7 +124,7 @@ ___
#### Defined in #### Defined in
medusa/dist/models/user.d.ts:12 packages/medusa/dist/models/user.d.ts:12
___ ___
@@ -130,7 +134,7 @@ ___
#### Defined in #### Defined in
medusa/dist/models/user.d.ts:8 packages/medusa/dist/models/user.d.ts:8
___ ___
@@ -140,8 +144,8 @@ ___
#### Inherited from #### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) [SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at)
#### Defined in #### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:7 packages/medusa/dist/interfaces/models/base-entity.d.ts:7
www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptReq.md
-23
View File
@@ -1,23 +0,0 @@
# Class: AdminPostInvitesInviteAcceptReq
[internal](../modules/internal-10.md).AdminPostInvitesInviteAcceptReq
## Properties
### token
• **token**: `string`
#### Defined in
medusa/dist/api/routes/admin/invites/accept-invite.d.ts:100
___
### user
• **user**: [`AdminPostInvitesInviteAcceptUserReq`](internal-10.AdminPostInvitesInviteAcceptUserReq.md)
#### Defined in
medusa/dist/api/routes/admin/invites/accept-invite.d.ts:101
www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md
-33
View File
@@ -1,33 +0,0 @@
# Class: AdminPostInvitesInviteAcceptUserReq
[internal](../modules/internal-10.md).AdminPostInvitesInviteAcceptUserReq
## Properties
### first\_name
• **first\_name**: `string`
#### Defined in
medusa/dist/api/routes/admin/invites/accept-invite.d.ts:95
___
### last\_name
• **last\_name**: `string`
#### Defined in
medusa/dist/api/routes/admin/invites/accept-invite.d.ts:96
___
### password
• **password**: `string`
#### Defined in
medusa/dist/api/routes/admin/invites/accept-invite.d.ts:97
www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesReq.md
-23
View File
@@ -1,23 +0,0 @@
# Class: AdminPostInvitesReq
[internal](../modules/internal-10.md).AdminPostInvitesReq
## Properties
### role
• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md)
#### Defined in
medusa/dist/api/routes/admin/invites/create-invite.d.ts:77
___
### user
• **user**: `string`
#### Defined in
medusa/dist/api/routes/admin/invites/create-invite.d.ts:76
www/apps/docs/content/references/js-client/classes/internal-10.Invite.md
-137
View File
@@ -1,137 +0,0 @@
# Class: Invite
[internal](../modules/internal-10.md).Invite
Base abstract entity for all entities
## Hierarchy
- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md)
↳ **`Invite`**
## Properties
### accepted
• **accepted**: `boolean`
#### Defined in
medusa/dist/models/invite.d.ts:6
___
### beforeInsert
• `Private` **beforeInsert**: `any`
#### Defined in
medusa/dist/models/invite.d.ts:10
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:6
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at)
#### Defined in
medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
___
### expires\_at
• **expires\_at**: `Date`
#### Defined in
medusa/dist/models/invite.d.ts:8
___
### id
• **id**: `string`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:5
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/models/invite.d.ts:9
___
### role
• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md)
#### Defined in
medusa/dist/models/invite.d.ts:5
___
### token
• **token**: `string`
#### Defined in
medusa/dist/models/invite.d.ts:7
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:7
___
### user\_email
• **user\_email**: `string`
#### Defined in
medusa/dist/models/invite.d.ts:4
www/apps/docs/content/references/js-client/classes/internal-11.AdminGetNotesParams.md
-33
View File
@@ -1,33 +0,0 @@
# Class: AdminGetNotesParams
[internal](../modules/internal-11.md).AdminGetNotesParams
## Properties
### limit
• **limit**: `number`
#### Defined in
medusa/dist/api/routes/admin/notes/list-notes.d.ts:70
___
### offset
• **offset**: `number`
#### Defined in
medusa/dist/api/routes/admin/notes/list-notes.d.ts:71
___
### resource\_id
• `Optional` **resource\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/notes/list-notes.d.ts:69
www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesNoteReq.md
-13
View File
@@ -1,13 +0,0 @@
# Class: AdminPostNotesNoteReq
[internal](../modules/internal-11.md).AdminPostNotesNoteReq
## Properties
### value
• **value**: `string`
#### Defined in
medusa/dist/api/routes/admin/notes/update-note.d.ts:73
www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesReq.md
-33
View File
@@ -1,33 +0,0 @@
# Class: AdminPostNotesReq
[internal](../modules/internal-11.md).AdminPostNotesReq
## Properties
### resource\_id
• **resource\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/notes/create-note.d.ts:84
___
### resource\_type
• **resource\_type**: `string`
#### Defined in
medusa/dist/api/routes/admin/notes/create-note.d.ts:85
___
### value
• **value**: `string`
#### Defined in
medusa/dist/api/routes/admin/notes/create-note.d.ts:86
www/apps/docs/content/references/js-client/classes/internal-11.Note.md
-137
View File
@@ -1,137 +0,0 @@
# Class: Note
[internal](../modules/internal-11.md).Note
Base abstract entity for all entities
## Hierarchy
- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md)
↳ **`Note`**
## Properties
### author
• **author**: [`User`](internal-1.User.md)
#### Defined in
medusa/dist/models/note.d.ts:8
___
### author\_id
• **author\_id**: `string`
#### Defined in
medusa/dist/models/note.d.ts:7
___
### beforeInsert
• `Private` **beforeInsert**: `any`
#### Defined in
medusa/dist/models/note.d.ts:10
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:6
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at)
#### Defined in
medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
___
### id
• **id**: `string`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:5
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/models/note.d.ts:9
___
### resource\_id
• **resource\_id**: `string`
#### Defined in
medusa/dist/models/note.d.ts:6
___
### resource\_type
• **resource\_type**: `string`
#### Defined in
medusa/dist/models/note.d.ts:5
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at)
#### Defined in
medusa/dist/interfaces/models/base-entity.d.ts:7
___
### value
• **value**: `string`
#### Defined in
medusa/dist/models/note.d.ts:4
www/apps/docs/content/references/js-client/classes/internal-12.AdminGetNotificationsParams.md
-93
View File
@@ -1,93 +0,0 @@
# Class: AdminGetNotificationsParams
[internal](../modules/internal-12.md).AdminGetNotificationsParams
## Properties
### event\_name
• `Optional` **event\_name**: `string`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:70
___
### expand
• `Optional` **expand**: `string`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:69
___
### fields
• `Optional` **fields**: `string`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:68
___
### include\_resends
• `Optional` **include\_resends**: `string`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:74
___
### limit
• `Optional` **limit**: `number`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:66
___
### offset
• `Optional` **offset**: `number`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:67
___
### resource\_id
• `Optional` **resource\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:72
___
### resource\_type
• `Optional` **resource\_type**: `string`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:71
___
### to
• `Optional` **to**: `string`
#### Defined in
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:73
www/apps/docs/content/references/js-client/classes/internal-12.AdminPostNotificationsNotificationResendReq.md
-13
View File
@@ -1,13 +0,0 @@
# Class: AdminPostNotificationsNotificationResendReq
[internal](../modules/internal-12.md).AdminPostNotificationsNotificationResendReq
## Properties
### to
• `Optional` **to**: `string`
#### Defined in
medusa/dist/api/routes/admin/notifications/resend-notification.d.ts:65
www/apps/docs/content/references/js-client/classes/internal.Axios.md → www/apps/docs/content/references/js-client/classes/internal-12.Axios.md
+33 -33
View File
@@ -4,23 +4,23 @@ displayed_sidebar: jsClientSidebar
# Class: Axios # Class: Axios
[internal](../modules/internal.md).Axios [internal](../modules/internal-12.md).Axios
## Hierarchy ## Hierarchy
- **`Axios`** - **`Axios`**
↳ [`AxiosInstance`](../interfaces/internal.AxiosInstance.md) ↳ [`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md)
## Properties ## Properties
### defaults ### defaults
• **defaults**: [`AxiosDefaults`](../interfaces/internal.AxiosDefaults.md)<`any`\> • **defaults**: [`AxiosDefaults`](../interfaces/internal-12.AxiosDefaults.md)<`any`\>
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:171 packages/medusa-js/node_modules/axios/index.d.ts:171
___ ___
@@ -32,12 +32,12 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `request` | [`AxiosInterceptorManager`](../interfaces/internal.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`any`\>\> | | `request` | [`AxiosInterceptorManager`](../interfaces/internal-12.AxiosInterceptorManager.md)<`AxiosRequestConfig`<`any`\>\> |
| `response` | [`AxiosInterceptorManager`](../interfaces/internal.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`any`, `any`\>\> | | `response` | [`AxiosInterceptorManager`](../interfaces/internal-12.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`any`, `any`\>\> |
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:172 packages/medusa-js/node_modules/axios/index.d.ts:172
## Methods ## Methods
@@ -50,7 +50,7 @@ medusa-js/node_modules/axios/index.d.ts:172
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | `any` | | `T` | `any` |
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | | `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` | | `D` | `any` |
#### Parameters #### Parameters
@@ -58,7 +58,7 @@ medusa-js/node_modules/axios/index.d.ts:172
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `url` | `string` | | `url` | `string` |
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | | `config?` | `AxiosRequestConfig`<`D`\> |
#### Returns #### Returns
@@ -66,7 +66,7 @@ medusa-js/node_modules/axios/index.d.ts:172
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:179 packages/medusa-js/node_modules/axios/index.d.ts:179
___ ___
@@ -79,7 +79,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | `any` | | `T` | `any` |
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | | `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` | | `D` | `any` |
#### Parameters #### Parameters
@@ -87,7 +87,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `url` | `string` | | `url` | `string` |
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | | `config?` | `AxiosRequestConfig`<`D`\> |
#### Returns #### Returns
@@ -95,7 +95,7 @@ ___
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:178 packages/medusa-js/node_modules/axios/index.d.ts:178
___ ___
@@ -107,7 +107,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`any`\> | | `config?` | `AxiosRequestConfig`<`any`\> |
#### Returns #### Returns
@@ -115,7 +115,7 @@ ___
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:176 packages/medusa-js/node_modules/axios/index.d.ts:176
___ ___
@@ -128,7 +128,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | `any` | | `T` | `any` |
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | | `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` | | `D` | `any` |
#### Parameters #### Parameters
@@ -136,7 +136,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `url` | `string` | | `url` | `string` |
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | | `config?` | `AxiosRequestConfig`<`D`\> |
#### Returns #### Returns
@@ -144,7 +144,7 @@ ___
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:180 packages/medusa-js/node_modules/axios/index.d.ts:180
___ ___
@@ -157,7 +157,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | `any` | | `T` | `any` |
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | | `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` | | `D` | `any` |
#### Parameters #### Parameters
@@ -165,7 +165,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `url` | `string` | | `url` | `string` |
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | | `config?` | `AxiosRequestConfig`<`D`\> |
#### Returns #### Returns
@@ -173,7 +173,7 @@ ___
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:181 packages/medusa-js/node_modules/axios/index.d.ts:181
___ ___
@@ -186,7 +186,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | `any` | | `T` | `any` |
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | | `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` | | `D` | `any` |
#### Parameters #### Parameters
@@ -195,7 +195,7 @@ ___
| :------ | :------ | | :------ | :------ |
| `url` | `string` | | `url` | `string` |
| `data?` | `D` | | `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | | `config?` | `AxiosRequestConfig`<`D`\> |
#### Returns #### Returns
@@ -203,7 +203,7 @@ ___
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:184 packages/medusa-js/node_modules/axios/index.d.ts:184
___ ___
@@ -216,7 +216,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | `any` | | `T` | `any` |
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | | `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` | | `D` | `any` |
#### Parameters #### Parameters
@@ -225,7 +225,7 @@ ___
| :------ | :------ | | :------ | :------ |
| `url` | `string` | | `url` | `string` |
| `data?` | `D` | | `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | | `config?` | `AxiosRequestConfig`<`D`\> |
#### Returns #### Returns
@@ -233,7 +233,7 @@ ___
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:182 packages/medusa-js/node_modules/axios/index.d.ts:182
___ ___
@@ -246,7 +246,7 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | `any` | | `T` | `any` |
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | | `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` | | `D` | `any` |
#### Parameters #### Parameters
@@ -255,7 +255,7 @@ ___
| :------ | :------ | | :------ | :------ |
| `url` | `string` | | `url` | `string` |
| `data?` | `D` | | `data?` | `D` |
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | | `config?` | `AxiosRequestConfig`<`D`\> |
#### Returns #### Returns
@@ -263,7 +263,7 @@ ___
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:183 packages/medusa-js/node_modules/axios/index.d.ts:183
___ ___
@@ -276,14 +276,14 @@ ___
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `T` | `any` | | `T` | `any` |
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | | `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
| `D` | `any` | | `D` | `any` |
#### Parameters #### Parameters
| Name | Type | | Name | Type |
| :------ | :------ | | :------ | :------ |
| `config` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | | `config` | `AxiosRequestConfig`<`D`\> |
#### Returns #### Returns
@@ -291,4 +291,4 @@ ___
#### Defined in #### Defined in
medusa-js/node_modules/axios/index.d.ts:177 packages/medusa-js/node_modules/axios/index.d.ts:177
www/apps/docs/content/references/js-client/classes/internal-12.Client.md
+186
View File
@@ -0,0 +1,186 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: Client
[internal](../modules/internal-12.md).Client
## Properties
### axiosClient
• `Private` **axiosClient**: [`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md)
#### Defined in
[packages/medusa-js/src/request.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L36)
___
### config
• `Private` **config**: [`Config`](../interfaces/internal-12.Config.md)
#### Defined in
[packages/medusa-js/src/request.ts:37](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L37)
## Methods
### createClient
▸ **createClient**(`config`): [`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md)
Creates the axios client used for requests
As part of the creation, we configure the retry conditions
and the exponential backoff approach.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | [`Config`](../interfaces/internal-12.Config.md) | user supplied configurations |
#### Returns
[`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md)
#### Defined in
[packages/medusa-js/src/request.ts:169](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L169)
___
### normalizeHeader
▸ **normalizeHeader**(`header`): `string`
#### Parameters
| Name | Type |
| :------ | :------ |
| `header` | `string` |
#### Returns
`string`
#### Defined in
[packages/medusa-js/src/request.ts:90](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L90)
___
### normalizeHeaders
▸ **normalizeHeaders**(`obj`): [`Record`](../modules/internal.md#record)<`string`, `any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `obj` | `object` |
#### Returns
[`Record`](../modules/internal.md#record)<`string`, `any`\>
#### Defined in
[packages/medusa-js/src/request.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L78)
___
### request
▸ **request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): `Promise`<`any`\>
Axios request
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `method` | [`RequestMethod`](../modules/internal-12.md#requestmethod) | request method |
| `path` | `string` | request path |
| `payload` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | request payload |
| `options` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) | axios configuration |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom request headers |
#### Returns
`Promise`<`any`\>
#### Defined in
[packages/medusa-js/src/request.ts:206](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L206)
___
### requiresAuthentication
▸ **requiresAuthentication**(`path`, `method`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `path` | `any` |
| `method` | `any` |
#### Returns
`boolean`
#### Defined in
[packages/medusa-js/src/request.ts:99](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L99)
___
### setHeaders
▸ **setHeaders**(`userHeaders`, `method`, `path`, `customHeaders?`): [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders)
Creates all the initial headers.
We add the idempotency key, if the request is configured to retry.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `userHeaders` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) | user supplied headers |
| `method` | [`RequestMethod`](../modules/internal-12.md#requestmethod) | request method |
| `path` | `string` | request path |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | user supplied headers |
#### Returns
[`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders)
#### Defined in
[packages/medusa-js/src/request.ts:115](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L115)
___
### shouldRetryCondition
▸ **shouldRetryCondition**(`err`, `numRetries`, `maxRetries`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | [`AxiosError`](../interfaces/internal-12.AxiosError.md)<`any`, `any`\> |
| `numRetries` | `number` |
| `maxRetries` | `number` |
#### Returns
`boolean`
#### Defined in
[packages/medusa-js/src/request.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L47)
www/apps/docs/content/references/js-client/classes/internal-12.Notification.md
-183
View File
@@ -1,183 +0,0 @@
# Class: Notification
[internal](../modules/internal-12.md).Notification
Base abstract entity for all entities
## Hierarchy
- [`BaseEntity`](internal.BaseEntity.md)
↳ **`Notification`**
## Properties
### beforeInsert
• `Private` **beforeInsert**: `any`
#### Defined in
medusa/dist/models/notification.d.ts:17
___
### 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
___
### customer
• **customer**: [`Customer`](internal.Customer.md)
#### Defined in
medusa/dist/models/notification.d.ts:9
___
### customer\_id
• **customer\_id**: ``null`` \| `string`
#### Defined in
medusa/dist/models/notification.d.ts:8
___
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/models/notification.d.ts:11
___
### event\_name
• **event\_name**: `string`
#### Defined in
medusa/dist/models/notification.d.ts:5
___
### 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
___
### parent\_id
• **parent\_id**: `string`
#### Defined in
medusa/dist/models/notification.d.ts:12
___
### parent\_notification
• **parent\_notification**: [`Notification`](internal-12.Notification.md)
#### Defined in
medusa/dist/models/notification.d.ts:13
___
### provider
• **provider**: [`NotificationProvider`](internal-12.NotificationProvider.md)
#### Defined in
medusa/dist/models/notification.d.ts:16
___
### provider\_id
• **provider\_id**: `string`
#### Defined in
medusa/dist/models/notification.d.ts:15
___
### resends
• **resends**: [`Notification`](internal-12.Notification.md)[]
#### Defined in
medusa/dist/models/notification.d.ts:14
___
### resource\_id
• **resource\_id**: `string`
#### Defined in
medusa/dist/models/notification.d.ts:7
___
### resource\_type
• **resource\_type**: `string`
#### Defined in
medusa/dist/models/notification.d.ts:6
___
### to
• **to**: `string`
#### Defined in
medusa/dist/models/notification.d.ts:10
___
### 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
www/apps/docs/content/references/js-client/classes/internal-12.NotificationProvider.md
-23
View File
@@ -1,23 +0,0 @@
# Class: NotificationProvider
[internal](../modules/internal-12.md).NotificationProvider
## Properties
### id
• **id**: `string`
#### Defined in
medusa/dist/models/notification-provider.d.ts:2
___
### is\_installed
• **is\_installed**: `boolean`
#### Defined in
medusa/dist/models/notification-provider.d.ts:3
www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md
-13
View File
@@ -1,13 +0,0 @@
# Class: AdminPostOrderEditsEditLineItemsLineItemReq
[internal](../modules/internal-13.md).AdminPostOrderEditsEditLineItemsLineItemReq
## Properties
### quantity
• **quantity**: `number`
#### Defined in
medusa/dist/api/routes/admin/order-edits/update-order-edit-line-item.d.ts:73
www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md
-33
View File
@@ -1,33 +0,0 @@
# Class: AdminPostOrderEditsEditLineItemsReq
[internal](../modules/internal-13.md).AdminPostOrderEditsEditLineItemsReq
## Properties
### metadata
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:82
___
### quantity
• **quantity**: `number`
#### Defined in
medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:81
___
### variant\_id
• **variant\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:80
www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsOrderEditReq.md
-13
View File
@@ -1,13 +0,0 @@
# Class: AdminPostOrderEditsOrderEditReq
[internal](../modules/internal-13.md).AdminPostOrderEditsOrderEditReq
## Properties
### internal\_note
• `Optional` **internal\_note**: `string`
#### Defined in
medusa/dist/api/routes/admin/order-edits/update-order-edit.d.ts:72
www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsReq.md
-23
View File
@@ -1,23 +0,0 @@
# Class: AdminPostOrderEditsReq
[internal](../modules/internal-13.md).AdminPostOrderEditsReq
## Properties
### internal\_note
• `Optional` **internal\_note**: `string`
#### Defined in
medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:72
___
### order\_id
• **order\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:71
www/apps/docs/content/references/js-client/classes/internal-13.GetOrderEditsOrderEditParams.md
-37
View File
@@ -1,37 +0,0 @@
# Class: GetOrderEditsOrderEditParams
[internal](../modules/internal-13.md).GetOrderEditsOrderEditParams
## Hierarchy
- [`FindParams`](internal-5.FindParams.md)
↳ **`GetOrderEditsOrderEditParams`**
## 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
www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem-1.md
-23
View File
@@ -1,23 +0,0 @@
# Class: AdditionalItem
[internal](../modules/internal-14.md).AdditionalItem
## Properties
### quantity
• **quantity**: `number`
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:206
___
### variant\_id
• **variant\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:205
www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem.md
-23
View File
@@ -1,23 +0,0 @@
# Class: AdditionalItem
[internal](../modules/internal-14.md).AdditionalItem
## Properties
### quantity
• **quantity**: `number`
#### Defined in
medusa/dist/api/routes/admin/orders/create-swap.d.ts:170
___
### variant\_id
• **variant\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/create-swap.d.ts:169
www/apps/docs/content/references/js-client/classes/internal-14.AdminGetOrdersParams.md
-273
View File
@@ -1,273 +0,0 @@
# Class: AdminGetOrdersParams
[internal](../modules/internal-14.md).AdminGetOrdersParams
## Hierarchy
- [`AdminListOrdersSelector`](internal-14.AdminListOrdersSelector.md)
↳ **`AdminGetOrdersParams`**
## Properties
### canceled\_at
• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[canceled_at](internal-14.AdminListOrdersSelector.md#canceled_at)
#### Defined in
medusa/dist/types/orders.d.ts:93
___
### cart\_id
• `Optional` **cart\_id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[cart_id](internal-14.AdminListOrdersSelector.md#cart_id)
#### Defined in
medusa/dist/types/orders.d.ts:86
___
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[created_at](internal-14.AdminListOrdersSelector.md#created_at)
#### Defined in
medusa/dist/types/orders.d.ts:94
___
### currency\_code
• `Optional` **currency\_code**: `string`
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[currency_code](internal-14.AdminListOrdersSelector.md#currency_code)
#### Defined in
medusa/dist/types/orders.d.ts:90
___
### customer\_id
• `Optional` **customer\_id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[customer_id](internal-14.AdminListOrdersSelector.md#customer_id)
#### Defined in
medusa/dist/types/orders.d.ts:87
___
### display\_id
• `Optional` **display\_id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[display_id](internal-14.AdminListOrdersSelector.md#display_id)
#### Defined in
medusa/dist/types/orders.d.ts:85
___
### email
• `Optional` **email**: `string`
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[email](internal-14.AdminListOrdersSelector.md#email)
#### Defined in
medusa/dist/types/orders.d.ts:88
___
### expand
• `Optional` **expand**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/list-orders.d.ts:209
___
### fields
• `Optional` **fields**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/list-orders.d.ts:210
___
### fulfillment\_status
• `Optional` **fulfillment\_status**: `string`[]
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[fulfillment_status](internal-14.AdminListOrdersSelector.md#fulfillment_status)
#### Defined in
medusa/dist/types/orders.d.ts:83
___
### id
• `Optional` **id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[id](internal-14.AdminListOrdersSelector.md#id)
#### Defined in
medusa/dist/types/orders.d.ts:81
___
### limit
• **limit**: `number`
#### Defined in
medusa/dist/api/routes/admin/orders/list-orders.d.ts:208
___
### offset
• **offset**: `number`
#### Defined in
medusa/dist/api/routes/admin/orders/list-orders.d.ts:207
___
### payment\_status
• `Optional` **payment\_status**: `string`[]
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[payment_status](internal-14.AdminListOrdersSelector.md#payment_status)
#### Defined in
medusa/dist/types/orders.d.ts:84
___
### q
• `Optional` **q**: `string`
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[q](internal-14.AdminListOrdersSelector.md#q)
#### Defined in
medusa/dist/types/orders.d.ts:80
___
### region\_id
• `Optional` **region\_id**: `string` \| `string`[]
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[region_id](internal-14.AdminListOrdersSelector.md#region_id)
#### Defined in
medusa/dist/types/orders.d.ts:89
___
### sales\_channel\_id
• `Optional` **sales\_channel\_id**: `string`[]
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[sales_channel_id](internal-14.AdminListOrdersSelector.md#sales_channel_id)
#### Defined in
medusa/dist/types/orders.d.ts:92
___
### status
• `Optional` **status**: `string`[]
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[status](internal-14.AdminListOrdersSelector.md#status)
#### Defined in
medusa/dist/types/orders.d.ts:82
___
### tax\_rate
• `Optional` **tax\_rate**: `string`
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[tax_rate](internal-14.AdminListOrdersSelector.md#tax_rate)
#### Defined in
medusa/dist/types/orders.d.ts:91
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
#### Inherited from
[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[updated_at](internal-14.AdminListOrdersSelector.md#updated_at)
#### Defined in
medusa/dist/types/orders.d.ts:95
www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md
-23
View File
@@ -1,23 +0,0 @@
# Class: AdminPostOrdersOrderClaimsClaimFulfillmentsReq
[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimFulfillmentsReq
## Properties
### metadata
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:69
___
### no\_notification
• `Optional` **no\_notification**: `boolean`
#### Defined in
medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:70
www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md
-43
View File
@@ -1,43 +0,0 @@
# Class: AdminPostOrdersOrderClaimsClaimReq
[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimReq
## Properties
### claim\_items
• `Optional` **claim\_items**: [`Item`](internal-14.Item-2.md)[]
#### Defined in
medusa/dist/api/routes/admin/orders/update-claim.d.ts:145
___
### metadata
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/api/routes/admin/orders/update-claim.d.ts:148
___
### no\_notification
• `Optional` **no\_notification**: `boolean`
#### Defined in
medusa/dist/api/routes/admin/orders/update-claim.d.ts:147
___
### shipping\_methods
• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-14.ShippingMethod-2.md)[]
#### Defined in
medusa/dist/api/routes/admin/orders/update-claim.d.ts:146
www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md
-23
View File
@@ -1,23 +0,0 @@
# Class: AdminPostOrdersOrderClaimsClaimShipmentsReq
[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimShipmentsReq
## Properties
### fulfillment\_id
• **fulfillment\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:79
___
### tracking\_numbers
• `Optional` **tracking\_numbers**: `string`[]
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:80
www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsReq.md
-93
View File
@@ -1,93 +0,0 @@
# Class: AdminPostOrdersOrderClaimsReq
[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsReq
## Properties
### additional\_items
• `Optional` **additional\_items**: [`AdditionalItem`](internal-14.AdditionalItem-1.md)[]
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:180
___
### claim\_items
• **claim\_items**: [`Item`](internal-14.Item-1.md)[]
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:178
___
### metadata
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:185
___
### no\_notification
• `Optional` **no\_notification**: `boolean`
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:184
___
### refund\_amount
• `Optional` **refund\_amount**: `number`
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:182
___
### return\_shipping
• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping-2.md)
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:179
___
### shipping\_address
• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md)
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:183
___
### shipping\_methods
• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-14.ShippingMethod-1.md)[]
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:181
___
### type
• **type**: ``"refund"`` \| ``"replace"``
#### Defined in
medusa/dist/api/routes/admin/orders/create-claim.d.ts:177
www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md
-33
View File
@@ -1,33 +0,0 @@
# Class: AdminPostOrdersOrderFulfillmentsReq
[internal](../modules/internal-14.md).AdminPostOrdersOrderFulfillmentsReq
## Properties
### items
• **items**: [`Item`](internal-14.Item.md)[]
#### Defined in
medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:100
___
### metadata
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:102
___
### no\_notification
• `Optional` **no\_notification**: `boolean`
#### Defined in
medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:101
www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderRefundsReq.md
-43
View File
@@ -1,43 +0,0 @@
# Class: AdminPostOrdersOrderRefundsReq
[internal](../modules/internal-14.md).AdminPostOrdersOrderRefundsReq
## Properties
### amount
• **amount**: `number`
#### Defined in
medusa/dist/api/routes/admin/orders/refund-payment.d.ts:85
___
### no\_notification
• `Optional` **no\_notification**: `boolean`
#### Defined in
medusa/dist/api/routes/admin/orders/refund-payment.d.ts:88
___
### note
• `Optional` **note**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/refund-payment.d.ts:87
___
### reason
• **reason**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/refund-payment.d.ts:86
www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReq.md
-103
View File
@@ -1,103 +0,0 @@
# Class: AdminPostOrdersOrderReq
[internal](../modules/internal-14.md).AdminPostOrdersOrderReq
## Properties
### billing\_address
• `Optional` **billing\_address**: [`AddressPayload`](internal.AddressPayload.md)
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:131
___
### customer\_id
• `Optional` **customer\_id**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:136
___
### discounts
• `Optional` **discounts**: `Record`<`string`, `unknown`\>[]
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:135
___
### email
• `Optional` **email**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:130
___
### items
• `Optional` **items**: `Record`<`string`, `unknown`\>[]
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:133
___
### no\_notification
• `Optional` **no\_notification**: `boolean`
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:139
___
### payment\_method
• `Optional` **payment\_method**: [`PaymentMethod`](internal-14.PaymentMethod.md)
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:137
___
### region
• `Optional` **region**: `string`
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:134
___
### shipping\_address
• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md)
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:132
___
### shipping\_method
• `Optional` **shipping\_method**: [`ShippingMethod`](internal-14.ShippingMethod.md)[]
#### Defined in
medusa/dist/api/routes/admin/orders/update-order.d.ts:138
Loaded 100 of 1091 files, more files were not shown because too many files have changed in this diff. Show more