chore(docs): Generated JS Client Reference (#5334)
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]
committed by
GitHub
GitHub
parent
378ca1b36e
commit
daea35fe73
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AddressesResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,7 @@
|
||||
|
||||
### 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
|
||||
|
||||
@@ -19,21 +23,21 @@ Adds an address to a customers saved addresses
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersCustomerAddressesReq`](internal.StorePostCustomersCustomerAddressesReq.md) | contains information to create an address |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -42,21 +46,21 @@ Deletes an address of a customer
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `address_id` | `string` | id of the address to delete |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -66,12 +70,12 @@ Update an address of a customer
|
||||
| :------ | :------ | :------ |
|
||||
| `address_id` | `string` | id of customer |
|
||||
| `payload` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | address update |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: Admin
|
||||
|
||||
## Hierarchy
|
||||
@@ -14,7 +18,7 @@
|
||||
|
||||
#### 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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminAuthResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,72 +14,97 @@
|
||||
|
||||
### createSession
|
||||
|
||||
▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Creates an authenticated session
|
||||
▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
destroys an authenticated session
|
||||
▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
destroys an authenticated session
|
||||
|
||||
#### 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**(`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`**
|
||||
|
||||
Retrieves an authenticated session
|
||||
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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminBatchJobsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,103 +14,103 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `batchJobId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `batchJobId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostBatchesReq`](internal-2.AdminPostBatchesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetBatchParams`](internal-2.AdminGetBatchParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `batchJobId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminCollectionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,11 +14,7 @@
|
||||
|
||||
### addProducts
|
||||
|
||||
▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates products associated with a Product Collection
|
||||
▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -22,106 +22,106 @@ Updates products associated with a Product 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 |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Creates a collection.
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostCollectionsReq`](internal-3.AdminPostCollectionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Creates a collection.
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a collection
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of collection to delete. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a collection
|
||||
|
||||
#### 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**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists collections matching a query
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetCollectionsParams`](internal-3.AdminGetCollectionsParams.md) | Query for searching collections |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists collections matching a query
|
||||
|
||||
#### 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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Removes products associated with a Product Collection
|
||||
▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -129,52 +129,52 @@ Removes products associated with a Product 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 |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
get a collection
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the collection to retrieve. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
get a collection
|
||||
|
||||
#### 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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a collection
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -182,14 +182,18 @@ Updates a collection
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the collection to update. |
|
||||
| `payload` | [`AdminPostCollectionsCollectionReq`](internal-3.AdminPostCollectionsCollectionReq.md) | update to apply to collection. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a collection
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminCurrenciesResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,20 @@
|
||||
|
||||
### 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`**
|
||||
|
||||
@@ -18,34 +35,15 @@ Lists currencies.
|
||||
This feature is under development and may change in the future.
|
||||
To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\>
|
||||
|
||||
the list of currencies as well as the pagination properties.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/currencies.ts:20](https://github.com/medusajs/medusa/blob/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**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a currency
|
||||
This feature is under development and may change in the future.
|
||||
To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project.
|
||||
▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\>
|
||||
|
||||
#### 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. |
|
||||
| `payload` | [`AdminPostCurrenciesCurrencyReq`](internal-4.AdminPostCurrenciesCurrencyReq.md) | update to apply to currency. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -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)
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminCustomerGroupsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,7 @@
|
||||
|
||||
### 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.
|
||||
|
||||
@@ -19,22 +23,22 @@ Add multiple customers to a customer group.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `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 |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -42,22 +46,22 @@ Create a customer group.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminPostCustomerGroupsReq`](internal-5.AdminPostCustomerGroupsReq.md) | customer group info |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomerGroupsReq`](internal-6.AdminPostCustomerGroupsReq.md) | customer group info |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -66,21 +70,21 @@ Deletes a customer group.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the customer group |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -88,22 +92,22 @@ Lists customer groups.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetCustomerGroupsParams`](internal-5.AdminGetCustomerGroupsParams.md) | optional |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCustomerGroupsParams`](internal-6.AdminGetCustomerGroupsParams.md) | optional |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -112,22 +116,22 @@ List and count customers that belong to provided customer groups.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer group id |
|
||||
| `query?` | [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) | params for filtering customers |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) | params for filtering customers |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -136,22 +140,22 @@ Remove multiple customers from a customer group.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `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 |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -160,22 +164,22 @@ Retrieves a customer group.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer group id |
|
||||
| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-5.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-6.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -184,13 +188,13 @@ Updates a customer group
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer group id |
|
||||
| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-5.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-6.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminCustomersResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,7 @@
|
||||
|
||||
### 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
|
||||
|
||||
@@ -18,22 +22,22 @@ Creates a customer
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminPostCustomersReq`](internal-6.AdminPostCustomersReq.md) | information of customer |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomersReq`](internal-7.AdminPostCustomersReq.md) | information of customer |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -41,22 +45,22 @@ Lists customers
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) | optional |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) | optional |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -65,21 +69,21 @@ Retrieves a customer
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer id |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -88,13 +92,13 @@ Updates a customer
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer id |
|
||||
| `payload` | [`AdminPostCustomersCustomerReq`](internal-6.AdminPostCustomersCustomerReq.md) | data to update customer with |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomersCustomerReq`](internal-7.AdminPostCustomersCustomerReq.md) | data to update customer with |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminDiscountsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,194 +14,190 @@
|
||||
|
||||
### 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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Deletes a discount
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Delete a batch of items from a discount condition
|
||||
▸ **deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -205,26 +205,26 @@ Delete a batch of items from a discount condition
|
||||
| :------ | :------ |
|
||||
| `discountId` | `string` |
|
||||
| `conditionId` | `string` |
|
||||
| `payload` | [`AdminDeleteDiscountsDiscountConditionsConditionBatchReq`](internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteDiscountsDiscountConditionsConditionBatchReq`](internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Deletes a dynamic discount
|
||||
▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -232,25 +232,25 @@ Deletes a dynamic discount
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `code` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-7.md#admindiscountconditionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Gets a condition from a discount
|
||||
▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-8.md#admindiscountconditionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -258,51 +258,51 @@ Gets a condition from a discount
|
||||
| :------ | :------ |
|
||||
| `discountId` | `string` |
|
||||
| `conditionId` | `string` |
|
||||
| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-7.md#admindiscountslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists discounts
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-8.md#admindiscountslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetDiscountsParams`](internal-7.AdminGetDiscountsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetDiscountsParams`](internal-8.AdminGetDiscountsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Removes a region from a discount
|
||||
▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -310,101 +310,101 @@ Removes a region from a discount
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `regionId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a discount
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a discount by code
|
||||
▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `code` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates discount
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostDiscountsDiscountReq`](internal-7.AdminPostDiscountsDiscountReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDiscountsDiscountReq`](internal-8.AdminPostDiscountsDiscountReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a discount condition
|
||||
▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -412,14 +412,18 @@ Updates a discount condition
|
||||
| :------ | :------ |
|
||||
| `discountId` | `string` |
|
||||
| `conditionId` | `string` |
|
||||
| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-7.AdminPostDiscountsDiscountConditionsCondition.md) |
|
||||
| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-8.AdminPostDiscountsDiscountConditionsCondition.md) |
|
||||
| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminDraftOrdersResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,214 +14,210 @@
|
||||
|
||||
### 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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Update draft order
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.AdminPostDraftOrdersDraftOrderReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Update draft order line item
|
||||
▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -225,13 +225,17 @@ Update draft order line item
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `itemId` | `string` |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminGiftCardsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,124 +14,124 @@
|
||||
|
||||
### 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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Deletes a gift card
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a gift card
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-9.AdminPostGiftCardsGiftCardReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-8.internal.AdminPostGiftCardsGiftCardReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -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)
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminInvitesResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,102 +14,102 @@
|
||||
|
||||
### accept
|
||||
|
||||
▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-10.AdminPostInvitesInviteAcceptReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-8.internal.AdminPostInvitesInviteAcceptReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
#### 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**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostInvitesPayload`](../modules/internal-10.md#adminpostinvitespayload) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostInvitesPayload`](../modules/internal-9.md#adminpostinvitespayload) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
#### 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**(`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`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminNotesResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,104 +14,104 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostNotesReq`](internal-11.AdminPostNotesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostNotesReq`](internal-8.internal.AdminPostNotesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetNotesParams`](internal-11.AdminGetNotesParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetNotesParams`](internal-8.internal.AdminGetNotesParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostNotesNoteReq`](internal-11.AdminPostNotesNoteReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostNotesNoteReq`](internal-8.internal.AdminPostNotesNoteReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminNotificationsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,41 +14,41 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetNotificationsParams`](internal-12.AdminGetNotificationsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetNotificationsParams`](internal-8.internal.AdminGetNotificationsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-12.AdminPostNotificationsNotificationResendReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-8.internal.AdminPostNotificationsNotificationResendReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminOrderEditsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,113 +14,113 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrderEditsEditLineItemsReq`](internal-13.AdminPostOrderEditsEditLineItemsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrderEditsEditLineItemsReq`](internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostOrderEditsReq`](internal-13.AdminPostOrderEditsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrderEditsReq`](internal-8.internal.AdminPostOrderEditsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -124,42 +128,42 @@ ___
|
||||
| :------ | :------ |
|
||||
| `orderEditId` | `string` |
|
||||
| `itemChangeId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`GetOrderEditsParams`](internal-13.GetOrderEditsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`GetOrderEditsParams`](internal-8.internal.GetOrderEditsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -167,86 +171,86 @@ ___
|
||||
| :------ | :------ |
|
||||
| `orderEditId` | `string` |
|
||||
| `itemId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`GetOrderEditsOrderEditParams`](internal-13.GetOrderEditsOrderEditParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`GetOrderEditsOrderEditParams`](internal-8.internal.GetOrderEditsOrderEditParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrderEditsOrderEditReq`](internal-13.AdminPostOrderEditsOrderEditReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrderEditsOrderEditReq`](internal-8.internal.AdminPostOrderEditsOrderEditReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -254,13 +258,13 @@ ___
|
||||
| :------ | :------ |
|
||||
| `orderEditId` | `string` |
|
||||
| `itemId` | `string` |
|
||||
| `payload` | [`AdminPostOrderEditsEditLineItemsLineItemReq`](internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrderEditsEditLineItemsLineItemReq`](internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminOrdersResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,71 +14,71 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-14.AdminPostOrdersOrderShippingMethodsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -82,21 +86,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -105,21 +109,21 @@ ___
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `fulfillmentId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -127,21 +131,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `fulfillmentId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -149,21 +153,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -172,85 +176,85 @@ ___
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `fulfillmentId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-14.AdminPostOrdersOrderClaimsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-8.internal.AdminPostOrdersOrderClaimsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -258,88 +262,88 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-14.AdminPostOrdersOrderFulfillmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-14.AdminPostOrdersOrderShipmentReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-8.internal.AdminPostOrdersOrderShipmentReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-14.AdminPostOrdersOrderSwapsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-8.internal.AdminPostOrdersOrderSwapsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -347,22 +351,22 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -370,22 +374,22 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -393,43 +397,43 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetOrdersParams`](internal-14.AdminGetOrdersParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetOrdersParams`](internal-8.internal.AdminGetOrdersParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -437,109 +441,109 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-14.AdminPostOrdersOrderRefundsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-8.internal.AdminPostOrdersOrderRefundsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-14.AdminPostOrdersOrderReturnsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-8.internal.AdminPostOrdersOrderReturnsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`FindParams`](internal-5.FindParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`FindParams`](internal-6.FindParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderReq`](internal-14.AdminPostOrdersOrderReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderReq`](internal-8.internal.AdminPostOrdersOrderReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -547,13 +551,13 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-14.AdminPostOrdersOrderClaimsClaimReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminPaymentCollectionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,84 +14,84 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetPaymentCollectionsParams`](internal-8.internal.AdminGetPaymentCollectionsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminUpdatePaymentCollectionsReq`](internal-15.AdminUpdatePaymentCollectionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminUpdatePaymentCollectionsReq`](internal-8.internal.AdminUpdatePaymentCollectionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminPaymentsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,63 +14,63 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostPaymentRefundsReq`](internal-16.AdminPostPaymentRefundsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPaymentRefundsReq`](internal-8.internal.AdminPostPaymentRefundsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`GetPaymentsParams`](internal-16.GetPaymentsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`GetPaymentsParams`](internal-8.internal.GetPaymentsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminPriceListResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,93 +14,93 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-17.AdminPostPriceListPricesPricesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-8.internal.AdminPostPriceListPricesPricesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostPriceListsPriceListReq`](internal-17.AdminPostPriceListsPriceListReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPriceListsPriceListReq`](internal-8.internal.AdminPostPriceListsPriceListReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-17.AdminDeletePriceListPricesPricesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-8.internal.AdminDeletePriceListPricesPricesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -104,21 +108,43 @@ ___
|
||||
| :------ | :------ |
|
||||
| `priceListId` | `string` |
|
||||
| `productId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -126,98 +152,98 @@ ___
|
||||
| :------ | :------ |
|
||||
| `priceListId` | `string` |
|
||||
| `variantId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetPriceListPaginationParams`](internal-17.AdminGetPriceListPaginationParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetPriceListPaginationParams`](internal-8.internal.AdminGetPriceListPaginationParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`any`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-17.AdminGetPriceListsPriceListProductsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-8.internal.AdminGetPriceListsPriceListProductsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`any`\>
|
||||
|
||||
#### 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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-17.AdminPostPriceListsPriceListPriceListReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -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)
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminProductTagsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,18 +14,18 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetProductTagsParams`](internal-18.AdminGetProductTagsParams.md) |
|
||||
| `query?` | [`AdminGetProductTagsParams`](internal-8.internal.AdminGetProductTagsParams.md) |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminProductTypesResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,19 +14,19 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetProductTypesParams`](internal-19.AdminGetProductTypesParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetProductTypesParams`](internal-8.internal.AdminGetProductTypesParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminProductsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,93 +14,93 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductOptionsReq`](internal-20.AdminPostProductsProductOptionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductOptionsReq`](internal-8.internal.AdminPostProductsProductOptionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostProductsReq`](internal-20.AdminPostProductsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsReq`](internal-8.internal.AdminPostProductsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductVariantsReq`](internal-20.AdminPostProductsProductVariantsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductVariantsReq`](internal-8.internal.AdminPostProductsProductVariantsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -104,21 +108,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `optionId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -126,151 +130,151 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `variantId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetProductsParams`](internal-20.AdminGetProductsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetProductsParams`](internal-8.internal.AdminGetProductsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-20.md#adminproductslisttypesres)\>
|
||||
|
||||
**`Deprecated`**
|
||||
|
||||
Use [list](AdminProductTypesResource.md#list) instead.
|
||||
▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-8.internal.md#adminproductslisttypesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductMetadataReq`](internal-20.AdminPostProductsProductMetadataReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductMetadataReq`](internal-8.internal.AdminPostProductsProductMetadataReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductReq`](internal-20.AdminPostProductsProductReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductReq`](internal-8.internal.AdminPostProductsProductReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -278,22 +282,22 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `optionId` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductOptionsOption`](internal-20.AdminPostProductsProductOptionsOption.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductOptionsOption`](internal-8.internal.AdminPostProductsProductOptionsOption.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -301,13 +305,13 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `variantId` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-20.AdminPostProductsProductVariantsVariantReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-8.internal.AdminPostProductsProductVariantsVariantReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminPublishableApiKeyResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,136 +14,136 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostPublishableApiKeySalesChannelsBatchReq`](internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPublishableApiKeySalesChannelsBatchReq`](internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostPublishableApiKeysReq`](internal-21.AdminPostPublishableApiKeysReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPublishableApiKeysReq`](internal-8.internal.AdminPostPublishableApiKeysReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeletePublishableApiKeySalesChannelsBatchReq`](internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeletePublishableApiKeySalesChannelsBatchReq`](internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`GetPublishableApiKeysParams`](internal-21.GetPublishableApiKeysParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`GetPublishableApiKeysParams`](internal-8.internal.GetPublishableApiKeysParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`GetPublishableApiKeySalesChannelsParams`](internal-21.GetPublishableApiKeySalesChannelsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`GetPublishableApiKeySalesChannelsParams`](internal-8.internal.GetPublishableApiKeySalesChannelsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -147,36 +151,36 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | `Object` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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 |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostPublishableApiKeysPublishableApiKeyReq`](internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPublishableApiKeysPublishableApiKeyReq`](internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -198,4 +202,4 @@ ___
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminRegionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,149 +14,145 @@
|
||||
|
||||
### 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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
adds a payment provider to a region
|
||||
▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-22.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
adds a payment provider to a region
|
||||
|
||||
#### 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**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
creates a region.
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostRegionsReq`](internal-22.AdminPostRegionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostRegionsReq`](internal-8.internal.AdminPostRegionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
creates a region.
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a region
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of region to delete. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a region
|
||||
|
||||
#### 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**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
remove a country from a region's list of coutnries
|
||||
▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -160,27 +160,27 @@ remove a country from a region's list of coutnries
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `country_code` | `string` | the 2 character ISO code for the Country. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
remove a country from a region's list of coutnries
|
||||
|
||||
#### 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**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
remove a fulfillment provider from a region
|
||||
▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -188,27 +188,27 @@ remove a fulfillment provider from a region
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `provider_id` | `string` | the if of the fulfillment provider |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
remove a fulfillment provider from a region
|
||||
|
||||
#### 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**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
removes a payment provider from a region
|
||||
▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -216,123 +216,127 @@ removes a payment provider from a region
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `provider_id` | `string` | the id of the payment provider |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
removes a payment provider from a region
|
||||
|
||||
#### 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**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.md#adminregionslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
lists regions matching a query
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-8.internal.md#adminregionslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetRegionsParams`](internal-22.AdminGetRegionsParams.md) | query for searching regions |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetRegionsParams`](internal-8.internal.AdminGetRegionsParams.md) | query for searching regions |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
lists regions matching a query
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
get a region
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the region to retrieve. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
get a region
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
retrieves the list of fulfillment options available in a region
|
||||
▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
retrieves the list of fulfillment options available in a region
|
||||
|
||||
#### 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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
updates a region
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the region to update. |
|
||||
| `payload` | [`AdminPostRegionsRegionReq`](internal-22.AdminPostRegionsRegionReq.md) | update to apply to region. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostRegionsRegionReq`](internal-8.internal.AdminPostRegionsRegionReq.md) | update to apply to region. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
updates a region
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -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)
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminReturnReasonsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,133 +14,133 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Creates a return reason.
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostReturnReasonsReq`](internal-23.AdminPostReturnReasonsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostReturnReasonsReq`](internal-8.internal.AdminPostReturnReasonsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Creates a return reason.
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a return reason
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of return reason to delete. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a return reason
|
||||
|
||||
#### 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**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-23.md#adminreturnreasonslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists return reasons matching a query
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-8.internal.md#adminreturnreasonslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists return reasons matching a query
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
retrieves a return reason
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the return reason to retrieve. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
retrieves a return reason
|
||||
|
||||
#### 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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a return reason
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the return reason to update. |
|
||||
| `payload` | [`AdminPostReturnReasonsReasonReq`](internal-23.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostReturnReasonsReasonReq`](internal-8.internal.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a return reason
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminReturnsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,80 +14,80 @@
|
||||
|
||||
### cancel
|
||||
|
||||
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-24.md#adminreturnscancelres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
cancels a return
|
||||
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-8.internal.md#adminreturnscancelres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of return to cancel |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
cancels a return
|
||||
|
||||
#### 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**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-24.md#adminreturnslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
lists returns matching a query
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-8.internal.md#adminreturnslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetReturnsParams`](internal-24.AdminGetReturnsParams.md) | query for searching returns |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetReturnsParams`](internal-8.internal.AdminGetReturnsParams.md) | query for searching returns |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
lists returns matching a query
|
||||
|
||||
#### 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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-24.md#adminreturnsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
receive a return
|
||||
▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-8.internal.md#adminreturnsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the return to receive. |
|
||||
| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-24.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-8.internal.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
receive a return
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminSalesChannelsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -8,210 +12,274 @@
|
||||
|
||||
## 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.
|
||||
To use this feature please enable featureflag `sales_channels` in your medusa backend project.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Add products to a sales channel
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `salesChannelId` | `string` |
|
||||
| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostSalesChannelsChannelStockLocationsReq`](internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostSalesChannelsReq`](internal-25.AdminPostSalesChannelsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostSalesChannelsReq`](internal-8.internal.AdminPostSalesChannelsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
gets a sales channel
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `salesChannelId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
gets a sales channel
|
||||
|
||||
#### 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**(`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
|
||||
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 |
|
||||
| :------ | :------ |
|
||||
| `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`**
|
||||
|
||||
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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetSalesChannelsParams`](internal-25.AdminGetSalesChannelsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `salesChannelId` | `string` |
|
||||
| `payload` | [`AdminDeleteSalesChannelsChannelStockLocationsReq`](internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Remove products from a sales channel
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `salesChannelId` | `string` |
|
||||
| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
Remove products from a sales channel
|
||||
|
||||
#### 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**(`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
|
||||
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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
gets a sales channel
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `salesChannelId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
gets a sales channel
|
||||
|
||||
#### 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**(`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
|
||||
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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
updates a sales channel
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `salesChannelId` | `string` |
|
||||
| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-25.AdminPostSalesChannelsSalesChannelReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
updates a sales channel
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminShippingOptionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,134 +14,134 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
creates a shipping option.
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostShippingOptionsReq`](internal-26.AdminPostShippingOptionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostShippingOptionsReq`](internal-8.internal.AdminPostShippingOptionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
creates a shipping option.
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a shipping option
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of shipping option to delete. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a shipping option
|
||||
|
||||
#### 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**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-26.md#adminshippingoptionslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
lists shipping options matching a query
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-8.internal.md#adminshippingoptionslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetShippingOptionsParams`](internal-26.AdminGetShippingOptionsParams.md) | query for searching shipping options |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetShippingOptionsParams`](internal-8.internal.AdminGetShippingOptionsParams.md) | query for searching shipping options |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
lists shipping options matching a query
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
get a shipping option
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the shipping option to retrieve. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
get a shipping option
|
||||
|
||||
#### 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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
updates a shipping option
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the shipping option to update. |
|
||||
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-26.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-8.internal.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
updates a shipping option
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminShippingProfilesResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,103 +14,103 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostShippingProfilesReq`](internal-27.AdminPostShippingProfilesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostShippingProfilesReq`](internal-8.internal.AdminPostShippingProfilesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-27.AdminPostShippingProfilesProfileReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-8.internal.AdminPostShippingProfilesProfileReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -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)
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminStoresResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,157 +14,157 @@
|
||||
|
||||
### addCurrency
|
||||
|
||||
▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
adds a currency to the store.
|
||||
▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `currency_code` | `string` | code of the currency to add |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
adds a currency to the store.
|
||||
|
||||
#### 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**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a currency from the available store currencies
|
||||
▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `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
|
||||
|
||||
[`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
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a currency from the available store currencies
|
||||
|
||||
#### 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**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-28.md#adminpaymentproviderslist)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists the store's payment providers
|
||||
▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-8.internal.md#adminpaymentproviderslist)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists the store's payment providers
|
||||
|
||||
#### 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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
gets a medusa store
|
||||
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminExtendedStoresRes`](../modules/internal-8.internal.md#adminextendedstoresres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
gets a medusa store
|
||||
|
||||
#### 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**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates the store
|
||||
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminPostStoreReq`](internal-28.AdminPostStoreReq.md) | update to apply to the store. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostStoreReq`](internal-8.internal.AdminPostStoreReq.md) | update to apply to the store. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates the store
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminSwapsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,40 +14,40 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetSwapsParams`](internal-29.AdminGetSwapsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetSwapsParams`](internal-8.internal.AdminGetSwapsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminTaxRatesResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,245 +14,245 @@
|
||||
|
||||
### 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-30.AdminPostTaxRatesTaxRateProductsReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostTaxRatesReq`](internal-30.AdminPostTaxRatesReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesReq`](internal-8.internal.AdminPostTaxRatesReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetTaxRatesParams`](internal-30.AdminGetTaxRatesParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetTaxRatesParams`](internal-8.internal.AdminGetTaxRatesParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-30.AdminPostTaxRatesTaxRateReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-8.internal.AdminPostTaxRatesTaxRateReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminUploadsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -20,86 +24,118 @@
|
||||
|
||||
#### 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
|
||||
|
||||
### create
|
||||
### \_createPayload
|
||||
|
||||
▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\>
|
||||
▸ `Private` **_createPayload**(`file`): `FormData`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) |
|
||||
| `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\>
|
||||
`FormData`
|
||||
|
||||
#### 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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) | File or array of files to upload. |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminDeleteUploadsReq`](internal-31.AdminDeleteUploadsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteUploadsReq`](internal-8.internal.AdminDeleteUploadsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-31.AdminPostUploadsDownloadUrlReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-8.internal.AdminPostUploadsDownloadUrlReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminUsersResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,112 +14,112 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
creates a user with the provided information
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminCreateUserPayload`](../modules/internal-32.md#admincreateuserpayload) | user creation request body |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminCreateUserPayload`](../modules/internal-11.md#admincreateuserpayload) | user creation request body |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
creates a user with the provided information
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a user
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the user to be deleted |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a user
|
||||
|
||||
#### 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**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-32.md#adminuserslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
lists all users
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-8.internal.md#adminuserslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
lists all users
|
||||
|
||||
#### 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**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
resets the users password given the correct token.
|
||||
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminResetPasswordRequest`](internal-32.AdminResetPasswordRequest.md) | reset password information. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminResetPasswordRequest`](internal-8.internal.AdminResetPasswordRequest.md) | reset password information. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -124,67 +128,67 @@ Retrieves a given user
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the user |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
#### 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**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
resets password by re-sending password token.
|
||||
▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminResetPasswordTokenRequest`](internal-32.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminResetPasswordTokenRequest`](internal-8.internal.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
resets password by re-sending password token.
|
||||
|
||||
#### 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**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
updates a given user
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the user to update |
|
||||
| `payload` | [`AdminUpdateUserPayload`](../modules/internal-32.md#adminupdateuserpayload) | user update request body |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`AdminUpdateUserPayload`](../modules/internal-11.md#adminupdateuserpayload) | user update request body |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
**`Description`**
|
||||
|
||||
updates a given user
|
||||
|
||||
#### 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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminVariantsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -8,21 +12,72 @@
|
||||
|
||||
## 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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetVariantsParams`](internal-33.AdminGetVariantsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `variantId` | `string` | id of the variant to fetch inventory for |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AuthResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,97 +14,122 @@
|
||||
|
||||
### authenticate
|
||||
|
||||
▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Authenticates a customer using email and password combination
|
||||
▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostAuthReq`](internal-34.StorePostAuthReq.md) | authentication payload |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostAuthReq`](internal-8.internal.StorePostAuthReq.md) | authentication payload |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Removes authentication session
|
||||
▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Removes authentication session
|
||||
|
||||
#### 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**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-34.md#storegetauthemailres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Check if email exists
|
||||
▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-8.internal.md#storegetauthemailres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `email` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
Retrieves an authenticated session
|
||||
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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`StorePostAuthReq`](internal-8.internal.StorePostAuthReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: CartsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -14,13 +18,13 @@
|
||||
|
||||
#### 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
|
||||
|
||||
### 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
|
||||
|
||||
@@ -29,49 +33,49 @@ Adds a shipping method to cart
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | Id of cart |
|
||||
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-35.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-8.internal.StorePostCartsCartShippingMethodReq.md) | Contains id of shipping option and optional data |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
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.
|
||||
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
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -79,22 +83,22 @@ Creates a cart
|
||||
|
||||
| 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 |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `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`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
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 |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -129,21 +133,21 @@ Removes a discount from cart.
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `code` | `string` | discount code to remove |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
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 |
|
||||
| `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
|
||||
|
||||
[`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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -178,21 +182,21 @@ Refreshes a payment session.
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `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
|
||||
|
||||
[`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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -201,21 +205,21 @@ Retrieves a cart
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
|
||||
@@ -224,22 +228,22 @@ Refreshes a payment session.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-35.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-8.internal.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -248,22 +252,22 @@ Updates a cart
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `payload` | [`StorePostCartsCartReq`](internal-35.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartReq`](internal-8.internal.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -273,13 +277,13 @@ Updates the payment method
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `provider_id` | `string` | is required |
|
||||
| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-35.StorePostCartsCartPaymentSessionUpdateReq.md) | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md) | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: CollectionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,48 +14,48 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-36.md#storecollectionslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of collections
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-8.internal.md#storecollectionslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`StoreGetCollectionsParams`](internal-36.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`StoreGetCollectionsParams`](internal-8.internal.StoreGetCollectionsParams.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.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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-36.md#storecollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single collection
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-8.internal.md#storecollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the collection |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: CustomerResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -14,7 +18,7 @@
|
||||
|
||||
#### 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
|
||||
|
||||
[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
|
||||
|
||||
### 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
|
||||
|
||||
@@ -38,22 +42,22 @@ Creates a customer
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersReq`](internal-37.StorePostCustomersReq.md) | information of customer |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersReq`](internal-8.internal.StorePostCustomersReq.md) | information of customer |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
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 |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-37.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
#### 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**(`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
|
||||
|
||||
@@ -85,22 +89,22 @@ Retrieve customer orders
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-37.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-8.internal.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -108,22 +112,22 @@ Resets customer password
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersResetPasswordReq`](internal-37.StorePostCustomersResetPasswordReq.md) | info used to reset customer password |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersResetPasswordReq`](internal-8.internal.StorePostCustomersResetPasswordReq.md) | info used to reset customer password |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -131,21 +135,21 @@ Retrieves the customer that is currently logged
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -153,13 +157,13 @@ Updates a customer
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersCustomerReq`](internal-37.StorePostCustomersCustomerReq.md) | information to update customer with |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersCustomerReq`](internal-8.internal.StorePostCustomersCustomerReq.md) | information to update customer with |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: GiftCardsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,23 +14,23 @@
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-38.md#storegiftcardsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single GiftCard
|
||||
▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-8.internal.md#storegiftcardsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `code` | `string` | code of the gift card |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: LineItemsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,7 @@
|
||||
|
||||
### 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
|
||||
|
||||
@@ -19,22 +23,22 @@ Creates a line-item for a cart
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | id of cart |
|
||||
| `payload` | [`StorePostCartsCartLineItemsReq`](internal-39.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartLineItemsReq`](internal-8.internal.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -44,21 +48,21 @@ Remove a line-item from a cart
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | id of cart |
|
||||
| `line_id` | `string` | id of item to remove |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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.
|
||||
Only quantity updates are allowed
|
||||
@@ -69,13 +73,13 @@ Only quantity updates are allowed
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | id of cart |
|
||||
| `line_id` | `string` | id of item to update |
|
||||
| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-39.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-8.internal.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: OrderEditsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -17,7 +21,7 @@
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -25,7 +29,7 @@
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-40.StorePostOrderEditsOrderEditDecline.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-8.internal.StorePostOrderEditsOrderEditDecline.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -47,25 +51,25 @@ ___
|
||||
|
||||
#### 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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: OrdersResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,123 +14,123 @@
|
||||
|
||||
### 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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`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`**
|
||||
|
||||
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
|
||||
|
||||
[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**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Request access to a list of orders
|
||||
▸ **requestCustomerOrders**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersCustomerOrderClaimReq`](internal-41.StorePostCustomersCustomerOrderClaimReq.md) | display ids of orders to request |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersCustomerOrderClaimReq`](internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md) | display ids of orders to request |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)
|
||||
|
||||
**`Description`**
|
||||
|
||||
Request access to a list of orders
|
||||
|
||||
#### 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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves an order
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves an order by cart id
|
||||
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: PaymentCollectionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,7 @@
|
||||
|
||||
### 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
|
||||
|
||||
@@ -18,87 +22,87 @@
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `session_id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`StorePostPaymentCollectionsBatchSessionsAuthorizeReq`](internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`StorePostPaymentCollectionsBatchSessionsAuthorizeReq`](internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`StorePaymentCollectionSessionsReq`](internal-42.StorePaymentCollectionSessionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`StorePaymentCollectionSessionsReq`](internal-8.internal.StorePaymentCollectionSessionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`StorePostPaymentCollectionsBatchSessionsReq`](internal-42.StorePostPaymentCollectionsBatchSessionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`StorePostPaymentCollectionsBatchSessionsReq`](internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
@@ -106,34 +110,34 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `session_id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`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
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`StoreGetPaymentCollectionsParams`](internal-8.internal.StoreGetPaymentCollectionsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: PaymentMethodsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,7 @@
|
||||
|
||||
### 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
|
||||
|
||||
@@ -18,12 +22,12 @@ Lists customer payment methods
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -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)
|
||||
@@ -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)
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: ProductTypesResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,23 +14,23 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-44.md#storeproducttypeslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of product types
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-8.internal.md#storeproducttypeslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`StoreGetProductTypesParams`](internal-44.StoreGetProductTypesParams.md) | is optional. Can contain a limit and offset for the returned list |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`StoreGetProductTypesParams`](internal-8.internal.StoreGetProductTypesParams.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.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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: ProductVariantsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,48 +14,48 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-45.md#storevariantslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of of Product Variants
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-8.internal.md#storevariantslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`StoreGetVariantsParams`](internal-45.StoreGetVariantsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`StoreGetVariantsParams`](internal-8.internal.StoreGetVariantsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-45.md#storevariantsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single product variant
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-8.internal.md#storevariantsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: ProductsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -14,79 +18,79 @@
|
||||
|
||||
#### 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
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-46.md#storeproductslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of products
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-8.internal.md#storeproductslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`StoreGetProductsParams`](internal-46.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `query?` | [`StoreGetProductsParams`](internal-8.internal.StoreGetProductsParams.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.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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-46.md#storeproductsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single Product
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsRes`](../modules/internal-8.internal.md#storeproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-46.md#storepostsearchres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Searches for products
|
||||
▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-8.internal.md#storepostsearchres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `searchOptions` | [`StorePostSearchReq`](internal-46.StorePostSearchReq.md) | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `searchOptions` | [`StorePostSearchReq`](internal-8.internal.StorePostSearchReq.md) | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: RegionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,47 +14,47 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-47.md#storeregionslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of regions
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-8.internal.md#storeregionslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-47.md#storeregionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a region
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-8.internal.md#storeregionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: ReturnReasonsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,7 @@
|
||||
|
||||
### 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
|
||||
|
||||
@@ -18,37 +22,37 @@ Lists return reasons defined in Medusa Admin
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-48.md#storereturnreasonsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single Return Reason
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-8.internal.md#storereturnreasonsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: ReturnsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,7 +14,7 @@
|
||||
|
||||
### 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
|
||||
|
||||
@@ -18,13 +22,13 @@ Creates a return request
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostReturnsReq`](internal-49.StorePostReturnsReq.md) | details needed to create a return |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostReturnsReq`](internal-8.internal.StorePostReturnsReq.md) | details needed to create a return |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: ShippingOptionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,48 +14,48 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists shiping options available
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`StoreGetShippingOptionsParams`](internal-50.StoreGetShippingOptionsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `query?` | [`StoreGetShippingOptionsParams`](internal-8.internal.StoreGetShippingOptionsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists shiping options available for a cart
|
||||
▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `cart_id` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: SwapsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,48 +14,48 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Creates a swap from a cart
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`StorePostSwapsReq`](internal-51.StorePostSwapsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `payload` | [`StorePostSwapsReq`](internal-8.internal.StorePostSwapsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### 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
|
||||
|
||||
[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**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieves a swap by cart id
|
||||
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | id of cart |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### 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
|
||||
|
||||
[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)
|
||||
|
||||
@@ -1,7 +1,28 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: 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
|
||||
|
||||
### email
|
||||
@@ -10,7 +31,7 @@
|
||||
|
||||
#### 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
|
||||
|
||||
medusa/dist/api/routes/admin/auth/create-session.d.ts:77
|
||||
packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:79
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: User
|
||||
|
||||
[internal](../modules/internal-1.md).User
|
||||
@@ -6,7 +10,7 @@ Base abstract entity for all entities
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md)
|
||||
- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md)
|
||||
|
||||
↳ **`User`**
|
||||
|
||||
@@ -18,7 +22,7 @@ Base abstract entity for all entities
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/user.d.ts:13
|
||||
packages/medusa/dist/models/user.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
@@ -28,7 +32,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/user.d.ts:15
|
||||
packages/medusa/dist/models/user.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
@@ -38,11 +42,11 @@ ___
|
||||
|
||||
#### 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
|
||||
|
||||
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
|
||||
|
||||
[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
|
||||
|
||||
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
|
||||
|
||||
medusa/dist/models/user.d.ts:9
|
||||
packages/medusa/dist/models/user.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/user.d.ts:10
|
||||
packages/medusa/dist/models/user.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
@@ -86,11 +90,11 @@ ___
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id)
|
||||
[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id)
|
||||
|
||||
#### 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
|
||||
|
||||
medusa/dist/models/user.d.ts:11
|
||||
packages/medusa/dist/models/user.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/user.d.ts:14
|
||||
packages/medusa/dist/models/user.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
@@ -120,7 +124,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/user.d.ts:12
|
||||
packages/medusa/dist/models/user.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
@@ -130,7 +134,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/user.d.ts:8
|
||||
packages/medusa/dist/models/user.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
@@ -140,8 +144,8 @@ ___
|
||||
|
||||
#### 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
|
||||
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -4,23 +4,23 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
# Class: Axios
|
||||
|
||||
[internal](../modules/internal.md).Axios
|
||||
[internal](../modules/internal-12.md).Axios
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- **`Axios`**
|
||||
|
||||
↳ [`AxiosInstance`](../interfaces/internal.AxiosInstance.md)
|
||||
↳ [`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md)
|
||||
|
||||
## Properties
|
||||
|
||||
### defaults
|
||||
|
||||
• **defaults**: [`AxiosDefaults`](../interfaces/internal.AxiosDefaults.md)<`any`\>
|
||||
• **defaults**: [`AxiosDefaults`](../interfaces/internal-12.AxiosDefaults.md)<`any`\>
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `request` | [`AxiosInterceptorManager`](../interfaces/internal.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`any`\>\> |
|
||||
| `response` | [`AxiosInterceptorManager`](../interfaces/internal.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`any`, `any`\>\> |
|
||||
| `request` | [`AxiosInterceptorManager`](../interfaces/internal-12.AxiosInterceptorManager.md)<`AxiosRequestConfig`<`any`\>\> |
|
||||
| `response` | [`AxiosInterceptorManager`](../interfaces/internal-12.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`any`, `any`\>\> |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:172
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:172
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -50,7 +50,7 @@ medusa-js/node_modules/axios/index.d.ts:172
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
@@ -58,7 +58,7 @@ medusa-js/node_modules/axios/index.d.ts:172
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> |
|
||||
| `config?` | `AxiosRequestConfig`<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -66,7 +66,7 @@ medusa-js/node_modules/axios/index.d.ts:172
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
@@ -87,7 +87,7 @@ ___
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> |
|
||||
| `config?` | `AxiosRequestConfig`<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -95,7 +95,7 @@ ___
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`any`\> |
|
||||
| `config?` | `AxiosRequestConfig`<`any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -115,7 +115,7 @@ ___
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> |
|
||||
| `config?` | `AxiosRequestConfig`<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -144,7 +144,7 @@ ___
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
@@ -165,7 +165,7 @@ ___
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> |
|
||||
| `config?` | `AxiosRequestConfig`<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -173,7 +173,7 @@ ___
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
@@ -195,7 +195,7 @@ ___
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `data?` | `D` |
|
||||
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> |
|
||||
| `config?` | `AxiosRequestConfig`<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -203,7 +203,7 @@ ___
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
@@ -225,7 +225,7 @@ ___
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `data?` | `D` |
|
||||
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> |
|
||||
| `config?` | `AxiosRequestConfig`<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -233,7 +233,7 @@ ___
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
@@ -255,7 +255,7 @@ ___
|
||||
| :------ | :------ |
|
||||
| `url` | `string` |
|
||||
| `data?` | `D` |
|
||||
| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> |
|
||||
| `config?` | `AxiosRequestConfig`<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -263,7 +263,7 @@ ___
|
||||
|
||||
#### 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 |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> |
|
||||
| `D` | `any` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `config` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> |
|
||||
| `config` | `AxiosRequestConfig`<`D`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -291,4 +291,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:177
|
||||
packages/medusa-js/node_modules/axios/index.d.ts:177
|
||||
@@ -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)
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -1,63 +0,0 @@
|
||||
# Class: AdminPostOrdersOrderReturnsReq
|
||||
|
||||
[internal](../modules/internal-14.md).AdminPostOrdersOrderReturnsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### items
|
||||
|
||||
• **items**: [`OrdersReturnItem`](internal-14.OrdersReturnItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:125
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:129
|
||||
|
||||
___
|
||||
|
||||
### note
|
||||
|
||||
• `Optional` **note**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:127
|
||||
|
||||
___
|
||||
|
||||
### receive\_now
|
||||
|
||||
• `Optional` **receive\_now**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:128
|
||||
|
||||
___
|
||||
|
||||
### refund
|
||||
|
||||
• `Optional` **refund**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:130
|
||||
|
||||
___
|
||||
|
||||
### return\_shipping
|
||||
|
||||
• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:126
|
||||
@@ -1,33 +0,0 @@
|
||||
# Class: AdminPostOrdersOrderShipmentReq
|
||||
|
||||
[internal](../modules/internal-14.md).AdminPostOrdersOrderShipmentReq
|
||||
|
||||
## Properties
|
||||
|
||||
### fulfillment\_id
|
||||
|
||||
• **fulfillment\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-shipment.d.ts:81
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-shipment.d.ts:83
|
||||
|
||||
___
|
||||
|
||||
### tracking\_numbers
|
||||
|
||||
• `Optional` **tracking\_numbers**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-shipment.d.ts:82
|
||||
@@ -1,33 +0,0 @@
|
||||
# Class: AdminPostOrdersOrderShippingMethodsReq
|
||||
|
||||
[internal](../modules/internal-14.md).AdminPostOrdersOrderShippingMethodsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### data
|
||||
|
||||
• `Optional` **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:69
|
||||
|
||||
___
|
||||
|
||||
### option\_id
|
||||
|
||||
• **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:68
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:67
|
||||
@@ -1,63 +0,0 @@
|
||||
# Class: AdminPostOrdersOrderSwapsReq
|
||||
|
||||
[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### additional\_items
|
||||
|
||||
• `Optional` **additional\_items**: [`AdditionalItem`](internal-14.AdditionalItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:149
|
||||
|
||||
___
|
||||
|
||||
### allow\_backorder
|
||||
|
||||
• `Optional` **allow\_backorder**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:152
|
||||
|
||||
___
|
||||
|
||||
### custom\_shipping\_options
|
||||
|
||||
• `Optional` **custom\_shipping\_options**: [`CustomShippingOption`](internal-14.CustomShippingOption.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:150
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:151
|
||||
|
||||
___
|
||||
|
||||
### return\_items
|
||||
|
||||
• **return\_items**: [`ReturnItem`](internal-14.ReturnItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:147
|
||||
|
||||
___
|
||||
|
||||
### return\_shipping
|
||||
|
||||
• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping-1.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:148
|
||||
@@ -1,23 +0,0 @@
|
||||
# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsReq
|
||||
|
||||
[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsSwapFulfillmentsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### metadata
|
||||
|
||||
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:69
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:70
|
||||
@@ -1,33 +0,0 @@
|
||||
# Class: AdminPostOrdersOrderSwapsSwapShipmentsReq
|
||||
|
||||
[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsSwapShipmentsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### fulfillment\_id
|
||||
|
||||
• **fulfillment\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:82
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### tracking\_numbers
|
||||
|
||||
• `Optional` **tracking\_numbers**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:83
|
||||
@@ -1,23 +0,0 @@
|
||||
# Class: CustomShippingOption
|
||||
|
||||
[internal](../modules/internal-14.md).CustomShippingOption
|
||||
|
||||
## Properties
|
||||
|
||||
### option\_id
|
||||
|
||||
• **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:165
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:166
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user