docs: update Typedoc and regenerate references (#1994)
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
This commit is contained in:
Shahed Nasser
GitHub
53
.github/workflows/generate-js-reference.yml
vendored
Normal file
53
.github/workflows/generate-js-reference.yml
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
name: Generate JS Client Reference
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "master"
|
||||
paths:
|
||||
- packages/medusa-js/src/resources/**
|
||||
pull_request:
|
||||
types:
|
||||
- closed
|
||||
branches:
|
||||
- "master"
|
||||
paths:
|
||||
- packages/medusa-js/src/resources/**
|
||||
jobs:
|
||||
services:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Cancel Previous Runs
|
||||
uses: styfle/cancel-workflow-action@0.9.1
|
||||
with:
|
||||
access_token: ${{ github.token }}
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2.3.5
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js environment
|
||||
uses: actions/setup-node@v2.4.1
|
||||
with:
|
||||
node-version: "14"
|
||||
cache: "yarn"
|
||||
|
||||
- name: Install dependencies
|
||||
uses: ./.github/actions/cache-deps
|
||||
with:
|
||||
extension: reference
|
||||
|
||||
- name: Build Packages
|
||||
run: yarn build
|
||||
|
||||
- name: Generate Services Reference
|
||||
run: yarn generate:services
|
||||
|
||||
- name: Create Pull Request
|
||||
uses: peter-evans/create-pull-request@v4
|
||||
with:
|
||||
commit-message: 'docs: Generated JS Client Reference (automated)'
|
||||
base: 'master'
|
||||
title: 'docs: Generated JS Client Reference (automated)'
|
||||
labels: 'type: docs'
|
||||
add-paths: docs/content/references/js-client/**
|
||||
20
.github/workflows/generate-reference.yml
vendored
20
.github/workflows/generate-reference.yml
vendored
@@ -1,5 +1,10 @@
|
||||
name: Generate References
|
||||
name: Generate Reference
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "master"
|
||||
paths:
|
||||
- packages/medusa/src/services/**
|
||||
pull_request:
|
||||
types:
|
||||
- closed
|
||||
@@ -19,7 +24,6 @@ jobs:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2.3.5
|
||||
with:
|
||||
token: ${{ secrets.REFERENCE_PAT }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js environment
|
||||
@@ -39,9 +43,11 @@ jobs:
|
||||
- name: Generate Services Reference
|
||||
run: yarn generate:services
|
||||
|
||||
- uses: stefanzweifel/git-auto-commit-action@v4
|
||||
- name: Create Pull Request
|
||||
uses: peter-evans/create-pull-request@v4
|
||||
with:
|
||||
commit_message: "docs: automatically Generated Services Reference"
|
||||
file_pattern: docs/content/*
|
||||
skip_dirty_check: false
|
||||
branch: master
|
||||
commit-message: 'docs: Generated Services Reference (automated)'
|
||||
base: 'master'
|
||||
title: 'docs: Generated Services Reference (automated)'
|
||||
labels: 'type: docs'
|
||||
add-paths: docs/content/references/services/**
|
||||
|
||||
@@ -19,7 +19,7 @@ Adds an address to a customers saved addresses
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersCustomerAddressesReq`](internal.StorePostCustomersCustomerAddressesReq.md) | contains information to create an address |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -27,7 +27,7 @@ Adds an address to a customers saved addresses
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L16)
|
||||
[medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/addresses.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
@@ -42,7 +42,7 @@ Deletes an address of a customer
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `address_id` | `string` | id of the address to delete |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -50,7 +50,7 @@ Deletes an address of a customer
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/addresses.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L29)
|
||||
[medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/addresses.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ Update an address of a customer
|
||||
| :------ | :------ | :------ |
|
||||
| `address_id` | `string` | id of customer |
|
||||
| `payload` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | address update |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -74,4 +74,4 @@ Update an address of a customer
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/addresses.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L41)
|
||||
[medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/addresses.ts#L45)
|
||||
|
||||
@@ -14,7 +14,17 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L30)
|
||||
[medusa-js/src/resources/admin/index.ts:32](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### batchJobs
|
||||
|
||||
• **batchJobs**: [`AdminBatchJobsResource`](AdminBatchJobsResource.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/index.ts:33](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +34,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:34](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L34)
|
||||
[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +44,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L32)
|
||||
[medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +54,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L31)
|
||||
[medusa-js/src/resources/admin/index.ts:34](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L33)
|
||||
[medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L35)
|
||||
[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L36)
|
||||
[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +94,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L37)
|
||||
[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -94,7 +104,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L38)
|
||||
[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -104,7 +114,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L53)
|
||||
[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -114,7 +124,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L45)
|
||||
[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -124,7 +134,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L39)
|
||||
[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -134,7 +144,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L41)
|
||||
[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -144,7 +154,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L42)
|
||||
[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -154,7 +164,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L40)
|
||||
[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
@@ -164,7 +174,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L52)
|
||||
[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -174,7 +184,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L46)
|
||||
[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -184,7 +194,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L44)
|
||||
[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
### salesChannels
|
||||
|
||||
• **salesChannels**: [`AdminSalesChannelsResource`](AdminSalesChannelsResource.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -194,7 +214,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L51)
|
||||
[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -204,7 +224,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L49)
|
||||
[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -214,7 +234,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L50)
|
||||
[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -224,7 +244,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L48)
|
||||
[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -234,7 +254,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L54)
|
||||
[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -244,7 +264,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L55)
|
||||
[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -254,7 +274,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L43)
|
||||
[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -264,4 +284,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L47)
|
||||
[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/index.ts#L50)
|
||||
|
||||
@@ -10,24 +10,26 @@
|
||||
|
||||
### createSession
|
||||
|
||||
▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\>
|
||||
▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
|
||||
|
||||
**`description`** Creates an authenticated session
|
||||
**`Description`**
|
||||
|
||||
Creates an authenticated session
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostAuthReq`](internal.AdminPostAuthReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/auth.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L33)
|
||||
[medusa-js/src/resources/admin/auth.ts:37](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/auth.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -35,13 +37,15 @@ ___
|
||||
|
||||
▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
|
||||
|
||||
**`description`** destroys an authenticated session
|
||||
**`Description`**
|
||||
|
||||
destroys an authenticated session
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -49,27 +53,29 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/auth.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L22)
|
||||
[medusa-js/src/resources/admin/auth.ts:24](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/auth.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### getSession
|
||||
|
||||
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\>
|
||||
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
|
||||
|
||||
**`description`** Retrieves an authenticated session
|
||||
**`Description`**
|
||||
|
||||
Retrieves an authenticated session
|
||||
Usually used to check if authenticated session is alive.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L12)
|
||||
[medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/auth.ts#L12)
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
# Class: AdminBatchJobsResource
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `default`
|
||||
|
||||
↳ **`AdminBatchJobsResource`**
|
||||
|
||||
## Methods
|
||||
|
||||
### cancel
|
||||
|
||||
▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `batchJobId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.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/e38dd7f6/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)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `batchJobId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.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/e38dd7f6/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)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostBatchesReq`](internal-2.AdminPostBatchesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.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/e38dd7f6/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)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetBatchParams`](internal-2.AdminGetBatchParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.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/e38dd7f6/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)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `batchJobId` | `string` |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.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/e38dd7f6/packages/medusa-js/src/resources/admin/batch-jobs.ts#L51)
|
||||
@@ -10,124 +10,134 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`description`** Creates a collection.
|
||||
**`Description`**
|
||||
|
||||
Creates a collection.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostCollectionsReq`](internal.AdminPostCollectionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostCollectionsReq`](internal-3.AdminPostCollectionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
Created collection.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L20)
|
||||
[medusa-js/src/resources/admin/collections.ts:20](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/collections.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** deletes a collection
|
||||
**`Description`**
|
||||
|
||||
deletes a collection
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of collection to delete. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
Deleted response
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L50)
|
||||
[medusa-js/src/resources/admin/collections.ts:50](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/collections.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal.md#admincollectionslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
|
||||
|
||||
**`description`** Lists collections matching a query
|
||||
**`Description`**
|
||||
|
||||
Lists collections matching a query
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetCollectionsParams`](internal.AdminGetCollectionsParams.md) | Query for searching collections |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCollectionsParams`](internal-3.AdminGetCollectionsParams.md) | Query for searching collections |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal.md#admincollectionslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
|
||||
|
||||
a list of collections matching the query.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L72)
|
||||
[medusa-js/src/resources/admin/collections.ts:78](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/collections.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`description`** get a collection
|
||||
**`Description`**
|
||||
|
||||
get a collection
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the collection to retrieve. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
the collection with the given id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L61)
|
||||
[medusa-js/src/resources/admin/collections.ts:64](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/collections.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`description`** Updates a collection
|
||||
**`Description`**
|
||||
|
||||
Updates a collection
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the collection to update. |
|
||||
| `payload` | [`AdminPostCollectionsCollectionReq`](internal.AdminPostCollectionsCollectionReq.md) | update to apply to collection. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCollectionsCollectionReq`](internal-3.AdminPostCollectionsCollectionReq.md) | update to apply to collection. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
the updated collection.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L35)
|
||||
[medusa-js/src/resources/admin/collections.ts:35](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/collections.ts#L35)
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
### addCustomers
|
||||
|
||||
▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
Add multiple customers to a customer group.
|
||||
|
||||
@@ -19,22 +19,22 @@ Add multiple customers to a customer group.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer group id |
|
||||
| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal.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`\> | |
|
||||
| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L112)
|
||||
[medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customer-groups.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
Create a customer group.
|
||||
|
||||
@@ -42,22 +42,22 @@ Create a customer group.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminPostCustomerGroupsReq`](internal.AdminPostCustomerGroupsReq.md) | customer group info |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomerGroupsReq`](internal-4.AdminPostCustomerGroupsReq.md) | customer group info |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L26)
|
||||
[medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customer-groups.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
Deletes a customer group.
|
||||
|
||||
@@ -66,21 +66,21 @@ Deletes a customer group.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the customer group |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L77)
|
||||
[medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customer-groups.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal.md#admincustomergroupslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-4.md#admincustomergroupslistres)\>
|
||||
|
||||
Lists customer groups.
|
||||
|
||||
@@ -88,22 +88,22 @@ Lists customer groups.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetCustomerGroupsParams`](internal.AdminGetCustomerGroupsParams.md) | optional |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCustomerGroupsParams`](internal-4.AdminGetCustomerGroupsParams.md) | optional |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal.md#admincustomergroupslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-4.md#admincustomergroupslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L91)
|
||||
[medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customer-groups.ts#L91)
|
||||
|
||||
___
|
||||
|
||||
### listCustomers
|
||||
|
||||
▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\>
|
||||
▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-4.md#admincustomerslistres)\>
|
||||
|
||||
List and count customers that belong to provided customer groups.
|
||||
|
||||
@@ -112,22 +112,22 @@ List and count customers that belong to provided customer groups.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer group id |
|
||||
| `query?` | [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md) | params for filtering customers |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCustomersParams`](internal-4.AdminGetCustomersParams.md) | params for filtering customers |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-4.md#admincustomerslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L144)
|
||||
[medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customer-groups.ts#L144)
|
||||
|
||||
___
|
||||
|
||||
### removeCustomers
|
||||
|
||||
▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
Remove multiple customers from a customer group.
|
||||
|
||||
@@ -136,22 +136,22 @@ Remove multiple customers from a customer group.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer group id |
|
||||
| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal.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`\> | |
|
||||
| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L128)
|
||||
[medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customer-groups.ts#L128)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
Retrieves a customer group.
|
||||
|
||||
@@ -160,22 +160,22 @@ Retrieves a customer group.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer group id |
|
||||
| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-4.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L41)
|
||||
[medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customer-groups.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
Updates a customer group
|
||||
|
||||
@@ -184,13 +184,13 @@ Updates a customer group
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer group id |
|
||||
| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-4.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-4.md#admincustomergroupsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L62)
|
||||
[medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customer-groups.ts#L62)
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\>
|
||||
|
||||
Creates a customer
|
||||
|
||||
@@ -18,22 +18,22 @@ Creates a customer
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminPostCustomersReq`](internal.AdminPostCustomersReq.md) | information of customer |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomersReq`](internal-5.AdminPostCustomersReq.md) | information of customer |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L18)
|
||||
[medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customers.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-4.md#admincustomerslistres)\>
|
||||
|
||||
Lists customers
|
||||
|
||||
@@ -41,22 +41,22 @@ Lists customers
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md) | optional |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetCustomersParams`](internal-4.AdminGetCustomersParams.md) | optional |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-4.md#admincustomerslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L59)
|
||||
[medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customers.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\>
|
||||
|
||||
Retrieves a customer
|
||||
|
||||
@@ -65,21 +65,21 @@ Retrieves a customer
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer id |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L46)
|
||||
[medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customers.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\>
|
||||
|
||||
Updates a customer
|
||||
|
||||
@@ -88,13 +88,13 @@ Updates a customer
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | customer id |
|
||||
| `payload` | [`AdminPostCustomersCustomerReq`](internal.AdminPostCustomersCustomerReq.md) | data to update customer with |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostCustomersCustomerReq`](internal-5.AdminPostCustomersCustomerReq.md) | data to update customer with |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-5.md#admincustomersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L32)
|
||||
[medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/customers.ts#L32)
|
||||
|
||||
@@ -10,9 +10,11 @@
|
||||
|
||||
### addRegion
|
||||
|
||||
▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Adds region to discount
|
||||
**`Description`**
|
||||
|
||||
Adds region to discount
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -20,118 +22,128 @@
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `regionId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L24)
|
||||
[medusa-js/src/resources/admin/discounts.ts:24](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Creates discounts
|
||||
**`Description`**
|
||||
|
||||
Creates discounts
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostDiscountsReq`](internal.AdminPostDiscountsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDiscountsReq`](internal-6.AdminPostDiscountsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L36)
|
||||
[medusa-js/src/resources/admin/discounts.ts:36](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### createCondition
|
||||
|
||||
▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** creates a discount condition
|
||||
**`Description`**
|
||||
|
||||
creates a discount condition
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `discountId` | `string` |
|
||||
| `payload` | [`AdminPostDiscountsDiscountConditions`](internal.AdminPostDiscountsDiscountConditions.md) |
|
||||
| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal.AdminPostDiscountsDiscountConditionsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDiscountsDiscountConditions`](internal-6.AdminPostDiscountsDiscountConditions.md) |
|
||||
| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal-6.AdminPostDiscountsDiscountConditionsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:145](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L145)
|
||||
[medusa-js/src/resources/admin/discounts.ts:145](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L145)
|
||||
|
||||
___
|
||||
|
||||
### createDynamicCode
|
||||
|
||||
▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Creates a dynamic discount code
|
||||
**`Description`**
|
||||
|
||||
Creates a dynamic discount code
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal.AdminPostDiscountsDiscountDynamicCodesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L59)
|
||||
[medusa-js/src/resources/admin/discounts.ts:59](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** Deletes a discount
|
||||
**`Description`**
|
||||
|
||||
Deletes a discount
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:71](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L71)
|
||||
[medusa-js/src/resources/admin/discounts.ts:71](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
### deleteCondition
|
||||
|
||||
▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** Removes a condition from a discount
|
||||
**`Description`**
|
||||
|
||||
Removes a condition from a discount
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -139,23 +151,25 @@ ___
|
||||
| :------ | :------ |
|
||||
| `discountId` | `string` |
|
||||
| `conditionId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:184](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L184)
|
||||
[medusa-js/src/resources/admin/discounts.ts:184](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L184)
|
||||
|
||||
___
|
||||
|
||||
### deleteDynamicCode
|
||||
|
||||
▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Deletes a dynamic discount
|
||||
**`Description`**
|
||||
|
||||
Deletes a dynamic discount
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -163,23 +177,25 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `code` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:82](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L82)
|
||||
[medusa-js/src/resources/admin/discounts.ts:82](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
### getCondition
|
||||
|
||||
▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal.md#admindiscountconditionsres)\>
|
||||
▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-6.md#admindiscountconditionsres)\>
|
||||
|
||||
**`description`** Gets a condition from a discount
|
||||
**`Description`**
|
||||
|
||||
Gets a condition from a discount
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -187,47 +203,51 @@ ___
|
||||
| :------ | :------ |
|
||||
| `discountId` | `string` |
|
||||
| `conditionId` | `string` |
|
||||
| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal.AdminGetDiscountsDiscountConditionsConditionParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal.md#admindiscountconditionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-6.md#admindiscountconditionsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:196](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L196)
|
||||
[medusa-js/src/resources/admin/discounts.ts:196](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L196)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal.md#admindiscountslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-6.md#admindiscountslistres)\>
|
||||
|
||||
**`description`** Lists discounts
|
||||
**`Description`**
|
||||
|
||||
Lists discounts
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetDiscountsParams`](internal.AdminGetDiscountsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetDiscountsParams`](internal-6.AdminGetDiscountsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal.md#admindiscountslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-6.md#admindiscountslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:116](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L116)
|
||||
[medusa-js/src/resources/admin/discounts.ts:116](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
### removeRegion
|
||||
|
||||
▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Removes a region from a discount
|
||||
**`Description`**
|
||||
|
||||
Removes a region from a discount
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -235,93 +255,101 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `regionId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:133](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L133)
|
||||
[medusa-js/src/resources/admin/discounts.ts:133](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L133)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Retrieves a discount
|
||||
**`Description`**
|
||||
|
||||
Retrieves a discount
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:94](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L94)
|
||||
[medusa-js/src/resources/admin/discounts.ts:94](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCode
|
||||
|
||||
▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Retrieves a discount by code
|
||||
**`Description`**
|
||||
|
||||
Retrieves a discount by code
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `code` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:105](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L105)
|
||||
[medusa-js/src/resources/admin/discounts.ts:105](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L105)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Updates discount
|
||||
**`Description`**
|
||||
|
||||
Updates discount
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostDiscountsDiscountReq`](internal.AdminPostDiscountsDiscountReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDiscountsDiscountReq`](internal-6.AdminPostDiscountsDiscountReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L47)
|
||||
[medusa-js/src/resources/admin/discounts.ts:47](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
### updateCondition
|
||||
|
||||
▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
**`description`** Updates a discount condition
|
||||
**`Description`**
|
||||
|
||||
Updates a discount condition
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -329,14 +357,14 @@ ___
|
||||
| :------ | :------ |
|
||||
| `discountId` | `string` |
|
||||
| `conditionId` | `string` |
|
||||
| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal.AdminPostDiscountsDiscountConditionsCondition.md) |
|
||||
| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal.AdminPostDiscountsDiscountConditionsConditionParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-6.AdminPostDiscountsDiscountConditionsCondition.md) |
|
||||
| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-6.md#admindiscountsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/discounts.ts:164](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L164)
|
||||
[medusa-js/src/resources/admin/discounts.ts:164](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/discounts.ts#L164)
|
||||
|
||||
@@ -10,125 +10,137 @@
|
||||
|
||||
### addLineItem
|
||||
|
||||
▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
**`description`** Add line item to draft order
|
||||
**`Description`**
|
||||
|
||||
Add line item to draft order
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L29)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:30](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
**`description`** Creates a draft order
|
||||
**`Description`**
|
||||
|
||||
Creates a draft order
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal.AdminPostDraftOrdersDraftOrderReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-7.AdminPostDraftOrdersDraftOrderReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L19)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:19](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** Delete draft order
|
||||
**`Description`**
|
||||
|
||||
Delete draft order
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L40)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:42](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal.md#admindraftorderslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-7.md#admindraftorderslistres)\>
|
||||
|
||||
**`description`** Lists draft orders
|
||||
**`Description`**
|
||||
|
||||
Lists draft orders
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetDraftOrdersParams`](internal.AdminGetDraftOrdersParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetDraftOrdersParams`](internal-7.AdminGetDraftOrdersParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal.md#admindraftorderslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-7.md#admindraftorderslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:67](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L67)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:76](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
### markPaid
|
||||
|
||||
▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal.md#adminpostdraftordersdraftorderregisterpaymentres)\>
|
||||
▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-7.md#adminpostdraftordersdraftorderregisterpaymentres)\>
|
||||
|
||||
**`description`** Mark a draft order as paid
|
||||
**`Description`**
|
||||
|
||||
Mark a draft order as paid
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal.md#adminpostdraftordersdraftorderregisterpaymentres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-7.md#adminpostdraftordersdraftorderregisterpaymentres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:83](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L83)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:93](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L93)
|
||||
|
||||
___
|
||||
|
||||
### removeLineItem
|
||||
|
||||
▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
**`description`** Remove line item
|
||||
**`Description`**
|
||||
|
||||
Remove line item
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -136,70 +148,76 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `itemId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L48)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:53](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
**`description`** Retrieves a draft order
|
||||
**`Description`**
|
||||
|
||||
Retrieves a draft order
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L59)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:65](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
**`description`** Update draft order
|
||||
**`Description`**
|
||||
|
||||
Update draft order
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal.AdminPostDraftOrdersDraftOrderReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-7.AdminPostDraftOrdersDraftOrderReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:94](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L94)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:104](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L104)
|
||||
|
||||
___
|
||||
|
||||
### updateLineItem
|
||||
|
||||
▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
**`description`** Update draft order line item
|
||||
**`Description`**
|
||||
|
||||
Update draft order line item
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -207,13 +225,13 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `itemId` | `string` |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-7.md#admindraftordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/draft-orders.ts:105](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L105)
|
||||
[medusa-js/src/resources/admin/draft-orders.ts:116](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/draft-orders.ts#L116)
|
||||
|
||||
@@ -10,114 +10,124 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
|
||||
|
||||
**`description`** Creates a gift card
|
||||
**`Description`**
|
||||
|
||||
Creates a gift card
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostGiftCardsReq`](internal.AdminPostGiftCardsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostGiftCardsReq`](internal-8.AdminPostGiftCardsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L17)
|
||||
[medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** Deletes a gift card
|
||||
**`Description`**
|
||||
|
||||
Deletes a gift card
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/gift-cards.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L36)
|
||||
[medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal.md#admingiftcardslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.md#admingiftcardslistres)\>
|
||||
|
||||
**`description`** Lists gift cards
|
||||
**`Description`**
|
||||
|
||||
Lists gift cards
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetGiftCardsParams`](internal.AdminGetGiftCardsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetGiftCardsParams`](internal-8.AdminGetGiftCardsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal.md#admingiftcardslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.md#admingiftcardslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/gift-cards.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L52)
|
||||
[medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
|
||||
|
||||
**`description`** Deletes a gift card
|
||||
**`Description`**
|
||||
|
||||
Deletes a gift card
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/gift-cards.ts:44](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L44)
|
||||
[medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
|
||||
|
||||
**`description`** Updates a gift card
|
||||
**`Description`**
|
||||
|
||||
Updates a gift card
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal.AdminPostGiftCardsGiftCardReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-8.AdminPostGiftCardsGiftCardReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.md#admingiftcardsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/gift-cards.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L25)
|
||||
[medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/gift-cards.ts#L28)
|
||||
|
||||
@@ -16,8 +16,8 @@
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal.AdminPostInvitesInviteAcceptReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-9.AdminPostInvitesInviteAcceptReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L10)
|
||||
[medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/invites.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -37,8 +37,8 @@ ___
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostInvitesPayload`](../modules/internal.md#adminpostinvitespayload) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostInvitesPayload`](../modules/internal-9.md#adminpostinvitespayload) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -46,48 +46,48 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/invites.ts:15](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L15)
|
||||
[medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/invites.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/invites.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L20)
|
||||
[medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/invites.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal.md#adminlistinvitesres)\>
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-9.md#adminlistinvitesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal.md#adminlistinvitesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-9.md#adminlistinvitesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/invites.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L25)
|
||||
[medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/invites.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +100,7 @@ ___
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -108,4 +108,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/invites.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L30)
|
||||
[medusa-js/src/resources/admin/invites.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/invites.ts#L41)
|
||||
|
||||
@@ -10,104 +10,104 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostNotesReq`](internal.AdminPostNotesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostNotesReq`](internal-10.AdminPostNotesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L14)
|
||||
[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/notes.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L27)
|
||||
[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal.md#adminnoteslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-10.md#adminnoteslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetNotesParams`](internal.AdminGetNotesParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetNotesParams`](internal-10.AdminGetNotesParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal.md#adminnoteslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-10.md#adminnoteslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/notes.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L37)
|
||||
[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/notes.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L32)
|
||||
[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostNotesNoteReq`](internal.AdminPostNotesNoteReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostNotesNoteReq`](internal-10.AdminPostNotesNoteReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-10.md#adminnotesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/notes.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L19)
|
||||
[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notes.ts#L22)
|
||||
|
||||
@@ -10,41 +10,41 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal.md#adminnotificationslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-11.md#adminnotificationslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetNotificationsParams`](internal.AdminGetNotificationsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetNotificationsParams`](internal-11.AdminGetNotificationsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal.md#adminnotificationslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-11.md#adminnotificationslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notifications.ts#L12)
|
||||
[medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notifications.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
### resend
|
||||
|
||||
▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal.md#adminnotificationsres)\>
|
||||
▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-11.md#adminnotificationsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal.AdminPostNotificationsNotificationResendReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-11.AdminPostNotificationsNotificationResendReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal.md#adminnotificationsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-11.md#adminnotificationsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/notifications.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notifications.ts#L25)
|
||||
[medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/notifications.ts#L26)
|
||||
|
||||
@@ -10,71 +10,71 @@
|
||||
|
||||
### addShippingMethod
|
||||
|
||||
▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal.AdminPostOrdersOrderShippingMethodsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-12.AdminPostOrdersOrderShippingMethodsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:153](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L153)
|
||||
[medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L144)
|
||||
|
||||
___
|
||||
|
||||
### archive
|
||||
|
||||
▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:162](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L162)
|
||||
[medusa-js/src/resources/admin/orders.ts:153](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
### cancel
|
||||
|
||||
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:145](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L145)
|
||||
[medusa-js/src/resources/admin/orders.ts:136](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L136)
|
||||
|
||||
___
|
||||
|
||||
### cancelClaim
|
||||
|
||||
▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -82,21 +82,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:226](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L226)
|
||||
[medusa-js/src/resources/admin/orders.ts:217](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L217)
|
||||
|
||||
___
|
||||
|
||||
### cancelClaimFulfillment
|
||||
|
||||
▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -105,21 +105,21 @@ ___
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `fulfillmentId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:117](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L117)
|
||||
[medusa-js/src/resources/admin/orders.ts:108](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L108)
|
||||
|
||||
___
|
||||
|
||||
### cancelFulfillment
|
||||
|
||||
▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -127,21 +127,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `fulfillmentId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:98](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L98)
|
||||
[medusa-js/src/resources/admin/orders.ts:89](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
### cancelSwap
|
||||
|
||||
▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -149,21 +149,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:179](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L179)
|
||||
[medusa-js/src/resources/admin/orders.ts:170](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L170)
|
||||
|
||||
___
|
||||
|
||||
### cancelSwapFulfillment
|
||||
|
||||
▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -172,106 +172,85 @@ ___
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `fulfillmentId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:107](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L107)
|
||||
[medusa-js/src/resources/admin/orders.ts:98](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
### capturePayment
|
||||
|
||||
▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L72)
|
||||
[medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
### complete
|
||||
|
||||
▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:64](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostOrdersReq`](internal.AdminPostOrdersReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L25)
|
||||
[medusa-js/src/resources/admin/orders.ts:55](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### createClaim
|
||||
|
||||
▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal.AdminPostOrdersOrderClaimsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-12.AdminPostOrdersOrderClaimsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:217](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L217)
|
||||
[medusa-js/src/resources/admin/orders.ts:208](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L208)
|
||||
|
||||
___
|
||||
|
||||
### createClaimShipment
|
||||
|
||||
▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -279,88 +258,88 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:255](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L255)
|
||||
[medusa-js/src/resources/admin/orders.ts:246](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L246)
|
||||
|
||||
___
|
||||
|
||||
### createFulfillment
|
||||
|
||||
▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal.AdminPostOrdersOrderFulfillmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-12.AdminPostOrdersOrderFulfillmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L89)
|
||||
[medusa-js/src/resources/admin/orders.ts:80](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
### createShipment
|
||||
|
||||
▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal.AdminPostOrdersOrderShipmentReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-12.AdminPostOrdersOrderShipmentReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:127](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L127)
|
||||
[medusa-js/src/resources/admin/orders.ts:118](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L118)
|
||||
|
||||
___
|
||||
|
||||
### createSwap
|
||||
|
||||
▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal.AdminPostOrdersOrderSwapsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-12.AdminPostOrdersOrderSwapsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:170](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L170)
|
||||
[medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L161)
|
||||
|
||||
___
|
||||
|
||||
### createSwapShipment
|
||||
|
||||
▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -368,44 +347,22 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:198](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L198)
|
||||
|
||||
___
|
||||
|
||||
### deleteMetadata
|
||||
|
||||
▸ **deleteMetadata**(`id`, `key`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `key` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:265](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L265)
|
||||
[medusa-js/src/resources/admin/orders.ts:189](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L189)
|
||||
|
||||
___
|
||||
|
||||
### fulfillClaim
|
||||
|
||||
▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -413,22 +370,22 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:245](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L245)
|
||||
[medusa-js/src/resources/admin/orders.ts:236](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L236)
|
||||
|
||||
___
|
||||
|
||||
### fulfillSwap
|
||||
|
||||
▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -436,43 +393,43 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:188](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L188)
|
||||
[medusa-js/src/resources/admin/orders.ts:179](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L179)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal.md#adminorderslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-12.md#adminorderslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetOrdersParams`](internal.AdminGetOrdersParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetOrdersParams`](internal-12.AdminGetOrdersParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal.md#adminorderslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-12.md#adminorderslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L50)
|
||||
[medusa-js/src/resources/admin/orders.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### processSwapPayment
|
||||
|
||||
▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -480,108 +437,108 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `swapId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:208](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L208)
|
||||
[medusa-js/src/resources/admin/orders.ts:199](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L199)
|
||||
|
||||
___
|
||||
|
||||
### refundPayment
|
||||
|
||||
▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal.AdminPostOrdersOrderRefundsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-12.AdminPostOrdersOrderRefundsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:80](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L80)
|
||||
[medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
### requestReturn
|
||||
|
||||
▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal.AdminPostOrdersOrderReturnsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-12.AdminPostOrdersOrderReturnsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:136](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L136)
|
||||
[medusa-js/src/resources/admin/orders.ts:127](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L127)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:42](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L42)
|
||||
[medusa-js/src/resources/admin/orders.ts:33](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderReq`](internal.AdminPostOrdersOrderReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderReq`](internal-12.AdminPostOrdersOrderReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L33)
|
||||
[medusa-js/src/resources/admin/orders.ts:24](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### updateClaim
|
||||
|
||||
▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -589,13 +546,13 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `claimId` | `string` |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal.AdminPostOrdersOrderClaimsClaimReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-12.AdminPostOrdersOrderClaimsClaimReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-12.md#adminordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/orders.ts:235](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L235)
|
||||
[medusa-js/src/resources/admin/orders.ts:226](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/orders.ts#L226)
|
||||
|
||||
@@ -10,93 +10,93 @@
|
||||
|
||||
### addPrices
|
||||
|
||||
▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
|
||||
▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostPriceListPricesPricesReq`](internal.AdminPostPriceListPricesPricesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-13.AdminPostPriceListPricesPricesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L80)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostPriceListsPriceListReq`](internal.AdminPostPriceListsPriceListReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPriceListsPriceListReq`](internal-13.AdminPostPriceListsPriceListReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L18)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L35)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:35](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
### deletePrices
|
||||
|
||||
▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
|
||||
▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal.AdminDeletePriceListPricesPricesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-13.AdminDeletePriceListPricesPricesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L89)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
### deleteProductPrices
|
||||
|
||||
▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
|
||||
▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -104,21 +104,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `priceListId` | `string` |
|
||||
| `productId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L98)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
### deleteVariantPrices
|
||||
|
||||
▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
|
||||
▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -126,36 +126,36 @@ ___
|
||||
| :------ | :------ |
|
||||
| `priceListId` | `string` |
|
||||
| `variantId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-13.md#adminpricelistdeletebatchres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L107)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal.md#adminpricelistslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-13.md#adminpricelistslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetPriceListPaginationParams`](internal.AdminGetPriceListPaginationParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetPriceListPaginationParams`](internal-13.AdminGetPriceListPaginationParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal.md#adminpricelistslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-13.md#adminpricelistslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L51)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -168,8 +168,8 @@ ___
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal.AdminGetPriceListsPriceListProductsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-13.AdminGetPriceListsPriceListProductsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -177,47 +177,47 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:65](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L65)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:65](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L43)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal.AdminPostPriceListsPriceListPriceListReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-13.AdminPostPriceListsPriceListPriceListReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-13.md#adminpricelistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L26)
|
||||
[medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/price-lists.ts#L26)
|
||||
|
||||
@@ -10,18 +10,18 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal.md#adminproducttagslistres)\>
|
||||
▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-14.md#adminproducttagslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetProductTagsParams`](internal.AdminGetProductTagsParams.md) |
|
||||
| `query?` | [`AdminGetProductTagsParams`](internal-14.AdminGetProductTagsParams.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal.md#adminproducttagslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-14.md#adminproducttagslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/product-tags.ts#L10)
|
||||
[medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/product-tags.ts#L10)
|
||||
|
||||
@@ -10,18 +10,18 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal.md#adminproducttypeslistres)\>
|
||||
▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-15.md#adminproducttypeslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetProductTypesParams`](internal.AdminGetProductTypesParams.md) |
|
||||
| `query?` | [`AdminGetProductTypesParams`](internal-15.AdminGetProductTypesParams.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal.md#adminproducttypeslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-15.md#adminproducttypeslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/product-types.ts#L10)
|
||||
[medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/product-types.ts#L10)
|
||||
|
||||
@@ -10,93 +10,93 @@
|
||||
|
||||
### addOption
|
||||
|
||||
▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductOptionsReq`](internal.AdminPostProductsProductOptionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductOptionsReq`](internal-16.AdminPostProductsProductOptionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:121](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L121)
|
||||
[medusa-js/src/resources/admin/products.ts:121](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostProductsReq`](internal.AdminPostProductsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsReq`](internal-16.AdminPostProductsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L23)
|
||||
[medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### createVariant
|
||||
|
||||
▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductVariantsReq`](internal.AdminPostProductsProductVariantsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductVariantsReq`](internal-16.AdminPostProductsProductVariantsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:93](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L93)
|
||||
[medusa-js/src/resources/admin/products.ts:93](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L93)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal.md#adminproductsdeleteres)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-16.md#adminproductsdeleteres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal.md#adminproductsdeleteres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-16.md#adminproductsdeleteres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L48)
|
||||
[medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### deleteOption
|
||||
|
||||
▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal.md#adminproductsdeleteoptionres)\>
|
||||
▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-16.md#adminproductsdeleteoptionres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -104,21 +104,21 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `optionId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal.md#adminproductsdeleteoptionres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-16.md#adminproductsdeleteoptionres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:140](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L140)
|
||||
[medusa-js/src/resources/admin/products.ts:140](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L140)
|
||||
|
||||
___
|
||||
|
||||
### deleteVariant
|
||||
|
||||
▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal.md#adminproductsdeletevariantres)\>
|
||||
▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-16.md#adminproductsdeletevariantres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -126,147 +126,147 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `variantId` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal.md#adminproductsdeletevariantres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-16.md#adminproductsdeletevariantres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:112](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L112)
|
||||
[medusa-js/src/resources/admin/products.ts:112](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal.md#adminproductslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-16.md#adminproductslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetProductsParams`](internal.AdminGetProductsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetProductsParams`](internal-16.AdminGetProductsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal.md#adminproductslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-16.md#adminproductslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L56)
|
||||
[medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### listTags
|
||||
|
||||
▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal.md#adminproductslisttagsres)\>
|
||||
▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-16.md#adminproductslisttagsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal.md#adminproductslisttagsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-16.md#adminproductslisttagsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:77](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L77)
|
||||
[medusa-js/src/resources/admin/products.ts:77](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
### listTypes
|
||||
|
||||
▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal.md#adminproductslisttypesres)\>
|
||||
▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-16.md#adminproductslisttypesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal.md#adminproductslisttypesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-16.md#adminproductslisttypesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:70](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L70)
|
||||
[medusa-js/src/resources/admin/products.ts:70](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L31)
|
||||
[medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### setMetadata
|
||||
|
||||
▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductMetadataReq`](internal.AdminPostProductsProductMetadataReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductMetadataReq`](internal-16.AdminPostProductsProductMetadataReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:84](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L84)
|
||||
[medusa-js/src/resources/admin/products.ts:84](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductReq`](internal.AdminPostProductsProductReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductReq`](internal-16.AdminPostProductsProductReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L39)
|
||||
[medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### updateOption
|
||||
|
||||
▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -274,22 +274,22 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `optionId` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductOptionsOption`](internal.AdminPostProductsProductOptionsOption.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductOptionsOption`](internal-16.AdminPostProductsProductOptionsOption.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:130](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L130)
|
||||
[medusa-js/src/resources/admin/products.ts:130](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
### updateVariant
|
||||
|
||||
▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -297,13 +297,13 @@ ___
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `variantId` | `string` |
|
||||
| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal.AdminPostProductsProductVariantsVariantReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-16.AdminPostProductsProductVariantsVariantReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-16.md#adminproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/products.ts:102](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L102)
|
||||
[medusa-js/src/resources/admin/products.ts:102](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/products.ts#L102)
|
||||
|
||||
@@ -10,137 +10,149 @@
|
||||
|
||||
### addCountry
|
||||
|
||||
▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** adds a country to the list of countries in a region
|
||||
**`Description`**
|
||||
|
||||
adds a country to the list of countries in a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal.AdminPostRegionsRegionCountriesReq.md) | country data |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-17.AdminPostRegionsRegionCountriesReq.md) | country data |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
updated region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:120](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L120)
|
||||
[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L103)
|
||||
|
||||
___
|
||||
|
||||
### addFulfillmentProvider
|
||||
|
||||
▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** adds a fulfillment provider to a region
|
||||
**`Description`**
|
||||
|
||||
adds a fulfillment provider to a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
updated region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:152](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L152)
|
||||
[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L135)
|
||||
|
||||
___
|
||||
|
||||
### addPaymentProvider
|
||||
|
||||
▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** adds a payment provider to a region
|
||||
**`Description`**
|
||||
|
||||
adds a payment provider to a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-17.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
updated region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:198](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L198)
|
||||
[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L181)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** creates a region.
|
||||
**`Description`**
|
||||
|
||||
creates a region.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostRegionsReq`](internal.AdminPostRegionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostRegionsReq`](internal-17.AdminPostRegionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
created region.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L25)
|
||||
[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** deletes a region
|
||||
**`Description`**
|
||||
|
||||
deletes a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of region to delete. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
Deleted response
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L52)
|
||||
[medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
### deleteCountry
|
||||
|
||||
▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** remove a country from a region's list of coutnries
|
||||
**`Description`**
|
||||
|
||||
remove a country from a region's list of coutnries
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -148,25 +160,27 @@ ___
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `country_code` | `string` | the 2 character ISO code for the Country. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
updated region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:136](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L136)
|
||||
[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
### deleteFulfillmentProvider
|
||||
|
||||
▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** remove a fulfillment provider from a region
|
||||
**`Description`**
|
||||
|
||||
remove a fulfillment provider from a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -174,51 +188,27 @@ ___
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `provider_id` | `string` | the if of the fulfillment provider |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
updated region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:168](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L168)
|
||||
|
||||
___
|
||||
|
||||
### deleteMetadata
|
||||
|
||||
▸ **deleteMetadata**(`id`, `key`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** delete a region's metadata key value pair
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `key` | `string` | metadata key |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
|
||||
updated region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:108](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L108)
|
||||
[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L151)
|
||||
|
||||
___
|
||||
|
||||
### deletePaymentProvider
|
||||
|
||||
▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** removes a payment provider from a region
|
||||
**`Description`**
|
||||
|
||||
removes a payment provider from a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -226,141 +216,123 @@ ___
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `provider_id` | `string` | the id of the payment provider |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
updated region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:214](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L214)
|
||||
[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L197)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal.md#adminregionslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-17.md#adminregionslistres)\>
|
||||
|
||||
**`description`** lists regions matching a query
|
||||
**`Description`**
|
||||
|
||||
lists regions matching a query
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetRegionsParams`](internal.AdminGetRegionsParams.md) | query for searching regions |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetRegionsParams`](internal-17.AdminGetRegionsParams.md) | query for searching regions |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal.md#adminregionslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-17.md#adminregionslistres)\>
|
||||
|
||||
a list of regions matching the query.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:74](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L74)
|
||||
[medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** get a region
|
||||
**`Description`**
|
||||
|
||||
get a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the region to retrieve. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
the region with the given id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:63](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L63)
|
||||
[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
### retrieveFulfillmentOptions
|
||||
|
||||
▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
|
||||
▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
|
||||
|
||||
**`description`** retrieves the list of fulfillment options available in a region
|
||||
**`Description`**
|
||||
|
||||
retrieves the list of fulfillment options available in a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
|
||||
|
||||
list of fulfillment options
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:183](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L183)
|
||||
|
||||
___
|
||||
|
||||
### setMetadata
|
||||
|
||||
▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** adds metadata to a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | region id |
|
||||
| `payload` | [`AdminPostRegionsRegionMetadata`](internal.AdminPostRegionsRegionMetadata.md) | metadata |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
|
||||
updated region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:92](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L92)
|
||||
[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L166)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
**`description`** updates a region
|
||||
**`Description`**
|
||||
|
||||
updates a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the region to update. |
|
||||
| `payload` | [`AdminPostRegionsRegionReq`](internal.AdminPostRegionsRegionReq.md) | update to apply to region. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostRegionsRegionReq`](internal-17.AdminPostRegionsRegionReq.md) | update to apply to region. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-17.AdminRegionsRes.md)\>
|
||||
|
||||
the updated region.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/regions.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L37)
|
||||
[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/regions.ts#L39)
|
||||
|
||||
@@ -10,123 +10,133 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\>
|
||||
|
||||
**`description`** Creates a return reason.
|
||||
**`Description`**
|
||||
|
||||
Creates a return reason.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostReturnReasonsReq`](internal.AdminPostReturnReasonsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostReturnReasonsReq`](internal-18.AdminPostReturnReasonsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\>
|
||||
|
||||
Created return reason.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L18)
|
||||
[medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/return-reasons.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** deletes a return reason
|
||||
**`Description`**
|
||||
|
||||
deletes a return reason
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of return reason to delete. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
Deleted response
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L48)
|
||||
[medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/return-reasons.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal.md#adminreturnreasonslistres)\>
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-18.md#adminreturnreasonslistres)\>
|
||||
|
||||
**`description`** Lists return reasons matching a query
|
||||
**`Description`**
|
||||
|
||||
Lists return reasons matching a query
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal.md#adminreturnreasonslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-18.md#adminreturnreasonslistres)\>
|
||||
|
||||
a list of return reasons matching the query.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/return-reasons.ts:69](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L69)
|
||||
[medusa-js/src/resources/admin/return-reasons.ts:75](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/return-reasons.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\>
|
||||
|
||||
**`description`** retrieves a return reason
|
||||
**`Description`**
|
||||
|
||||
retrieves a return reason
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the return reason to retrieve. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\>
|
||||
|
||||
the return reason with the given id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/return-reasons.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L59)
|
||||
[medusa-js/src/resources/admin/return-reasons.ts:62](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/return-reasons.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\>
|
||||
|
||||
**`description`** Updates a return reason
|
||||
**`Description`**
|
||||
|
||||
Updates a return reason
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the return reason to update. |
|
||||
| `payload` | [`AdminPostReturnReasonsReasonReq`](internal.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostReturnReasonsReasonReq`](internal-18.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-18.md#adminreturnreasonsres)\>
|
||||
|
||||
the updated return reason.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L33)
|
||||
[medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/return-reasons.ts#L33)
|
||||
|
||||
@@ -10,74 +10,80 @@
|
||||
|
||||
### cancel
|
||||
|
||||
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal.md#adminreturnscancelres)\>
|
||||
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-19.md#adminreturnscancelres)\>
|
||||
|
||||
**`description`** cancels a return
|
||||
**`Description`**
|
||||
|
||||
cancels a return
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of return to cancel |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal.md#adminreturnscancelres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-19.md#adminreturnscancelres)\>
|
||||
|
||||
the order for which the return was canceled
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L19)
|
||||
[medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/returns.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal.md#adminreturnslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-19.md#adminreturnslistres)\>
|
||||
|
||||
**`description`** lists returns matching a query
|
||||
**`Description`**
|
||||
|
||||
lists returns matching a query
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetReturnsParams`](internal.AdminGetReturnsParams.md) | query for searching returns |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetReturnsParams`](internal-19.AdminGetReturnsParams.md) | query for searching returns |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal.md#adminreturnslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-19.md#adminreturnslistres)\>
|
||||
|
||||
a list of returns matching the query
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/returns.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L46)
|
||||
[medusa-js/src/resources/admin/returns.ts:49](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/returns.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### receive
|
||||
|
||||
▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal.md#adminreturnsres)\>
|
||||
▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-19.md#adminreturnsres)\>
|
||||
|
||||
**`description`** receive a return
|
||||
**`Description`**
|
||||
|
||||
receive a return
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the return to receive. |
|
||||
| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-19.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal.md#adminreturnsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-19.md#adminreturnsres)\>
|
||||
|
||||
the return
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/returns.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L31)
|
||||
[medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/returns.ts#L34)
|
||||
|
||||
@@ -0,0 +1,217 @@
|
||||
# Class: AdminSalesChannelsResource
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `default`
|
||||
|
||||
↳ **`AdminSalesChannelsResource`**
|
||||
|
||||
## Methods
|
||||
|
||||
### addProducts
|
||||
|
||||
▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Add products to a sales channel
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `salesChannelId` | `string` |
|
||||
| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
a medusa sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/sales-channels.ts:116](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/sales-channels.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostSalesChannelsReq`](internal-20.AdminPostSalesChannelsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/sales-channels.ts:34](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/sales-channels.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.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`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
an deletion result
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/sales-channels.ts:85](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/sales-channels.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-20.md#adminsaleschannelslistres)\>
|
||||
|
||||
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.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Retrieve a list of sales channels
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetSalesChannelsParams`](internal-20.AdminGetSalesChannelsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-20.md#adminsaleschannelslistres)\>
|
||||
|
||||
the list of sales channel as well as the pagination properties
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/sales-channels.ts:64](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/sales-channels.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
### removeProducts
|
||||
|
||||
▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
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-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
a medusa sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/sales-channels.ts:100](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/sales-channels.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
retrieve 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`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
a medusa sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/sales-channels.ts:22](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/sales-channels.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
update 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-20.AdminPostSalesChannelsSalesChannelReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-20.md#adminsaleschannelsres)\>
|
||||
|
||||
the updated medusa sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/sales-channels.ts:48](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/sales-channels.ts#L48)
|
||||
@@ -10,124 +10,134 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
|
||||
|
||||
**`description`** creates a shipping option.
|
||||
**`Description`**
|
||||
|
||||
creates a shipping option.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostShippingOptionsReq`](internal.AdminPostShippingOptionsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostShippingOptionsReq`](internal-21.AdminPostShippingOptionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
|
||||
|
||||
created shipping option.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L20)
|
||||
[medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** deletes a shipping option
|
||||
**`Description`**
|
||||
|
||||
deletes a shipping option
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of shipping option to delete. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
deleted response
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L50)
|
||||
[medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal.md#adminshippingoptionslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-21.md#adminshippingoptionslistres)\>
|
||||
|
||||
**`description`** lists shipping options matching a query
|
||||
**`Description`**
|
||||
|
||||
lists shipping options matching a query
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetShippingOptionsParams`](internal.AdminGetShippingOptionsParams.md) | query for searching shipping options |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`AdminGetShippingOptionsParams`](internal-21.AdminGetShippingOptionsParams.md) | query for searching shipping options |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal.md#adminshippingoptionslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-21.md#adminshippingoptionslistres)\>
|
||||
|
||||
a list of shipping options matching the query.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-options.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L72)
|
||||
[medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
|
||||
|
||||
**`description`** get a shipping option
|
||||
**`Description`**
|
||||
|
||||
get a shipping option
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the shipping option to retrieve. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
|
||||
|
||||
the shipping option with the given id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-options.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L61)
|
||||
[medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
|
||||
|
||||
**`description`** updates a shipping option
|
||||
**`Description`**
|
||||
|
||||
updates a shipping option
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the shipping option to update. |
|
||||
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-21.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-21.md#adminshippingoptionsres)\>
|
||||
|
||||
the updated shipping option.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L35)
|
||||
[medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-options.ts#L35)
|
||||
|
||||
@@ -10,103 +10,103 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostShippingProfilesReq`](internal.AdminPostShippingProfilesReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostShippingProfilesReq`](internal-22.AdminPostShippingProfilesReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12)
|
||||
[medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L27)
|
||||
[medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal.md#adminshippingprofileslistres)\>
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-22.md#adminshippingprofileslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal.md#adminshippingprofileslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-22.md#adminshippingprofileslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37)
|
||||
[medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L32)
|
||||
[medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal.AdminPostShippingProfilesProfileReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-22.AdminPostShippingProfilesProfileReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-22.md#adminshippingprofilesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L19)
|
||||
[medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20)
|
||||
|
||||
@@ -10,145 +10,157 @@
|
||||
|
||||
### addCurrency
|
||||
|
||||
▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
|
||||
▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\>
|
||||
|
||||
**`description`** adds a currency to the store.
|
||||
**`Description`**
|
||||
|
||||
adds a currency to the store.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `currency_code` | `string` | code of the currency to add |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\>
|
||||
|
||||
updated store.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L31)
|
||||
[medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/store.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### deleteCurrency
|
||||
|
||||
▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
|
||||
▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\>
|
||||
|
||||
**`description`** deletes a currency from the available store currencies
|
||||
**`Description`**
|
||||
|
||||
deletes a currency from the available store currencies
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `currency_code` | `string` | currency code of the currency to delete from the store. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\>
|
||||
|
||||
updated store
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L45)
|
||||
[medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/store.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### listPaymentProviders
|
||||
|
||||
▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal.md#adminpaymentproviderslist)\>
|
||||
▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-23.md#adminpaymentproviderslist)\>
|
||||
|
||||
**`description`** Lists the store's payment providers
|
||||
**`Description`**
|
||||
|
||||
Lists the store's payment providers
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal.md#adminpaymentproviderslist)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-23.md#adminpaymentproviderslist)\>
|
||||
|
||||
a list of payment providers configured on the store
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L68)
|
||||
[medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/store.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
### listTaxProviders
|
||||
|
||||
▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal.md#admintaxproviderslist)\>
|
||||
▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-23.md#admintaxproviderslist)\>
|
||||
|
||||
**`description`** Lists the store's payment providers
|
||||
**`Description`**
|
||||
|
||||
Lists the store's payment providers
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal.md#admintaxproviderslist)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-23.md#admintaxproviderslist)\>
|
||||
|
||||
a list of payment providers configured on the store
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/store.ts:79](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L79)
|
||||
[medusa-js/src/resources/admin/store.ts:79](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/store.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
|
||||
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\>
|
||||
|
||||
**`description`** gets a medusa store
|
||||
**`Description`**
|
||||
|
||||
gets a medusa store
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\>
|
||||
|
||||
a medusa store
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L57)
|
||||
[medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/store.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
|
||||
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\>
|
||||
|
||||
**`description`** Updates the store
|
||||
**`Description`**
|
||||
|
||||
Updates the store
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminPostStoreReq`](internal.AdminPostStoreReq.md) | update to apply to the store. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminPostStoreReq`](internal-23.AdminPostStoreReq.md) | update to apply to the store. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-23.md#adminstoresres)\>
|
||||
|
||||
the updated store.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L17)
|
||||
[medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/store.ts#L17)
|
||||
|
||||
@@ -10,40 +10,40 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal.md#adminswapslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-24.md#adminswapslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetSwapsParams`](internal.AdminGetSwapsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetSwapsParams`](internal-24.AdminGetSwapsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal.md#adminswapslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-24.md#adminswapslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/swaps.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/swaps.ts#L16)
|
||||
[medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/swaps.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal.md#adminswapsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-24.md#adminswapsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal.md#adminswapsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-24.md#adminswapsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/swaps.ts#L11)
|
||||
[medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/swaps.ts#L11)
|
||||
|
||||
@@ -10,245 +10,245 @@
|
||||
|
||||
### addProductTypes
|
||||
|
||||
▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal.AdminPostTaxRatesTaxRateProductTypesReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L100)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
### addProducts
|
||||
|
||||
▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal.AdminPostTaxRatesTaxRateProductsReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-25.AdminPostTaxRatesTaxRateProductsReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L84)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
### addShippingOptions
|
||||
|
||||
▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L116)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostTaxRatesReq`](internal.AdminPostTaxRatesReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesReq`](internal-25.AdminPostTaxRatesReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L53)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L180)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L180)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal.md#admintaxrateslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-25.md#admintaxrateslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetTaxRatesParams`](internal.AdminGetTaxRatesParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetTaxRatesParams`](internal-25.AdminGetTaxRatesParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal.md#admintaxrateslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-25.md#admintaxrateslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L39)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### removeProductTypes
|
||||
|
||||
▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L148)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L148)
|
||||
|
||||
___
|
||||
|
||||
### removeProducts
|
||||
|
||||
▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal.AdminDeleteTaxRatesTaxRateProductsReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal.AdminDeleteTaxRatesTaxRateProductsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L132)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L132)
|
||||
|
||||
___
|
||||
|
||||
### removeShippingOptions
|
||||
|
||||
▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) |
|
||||
| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L164)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L164)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L24)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `id` | `string` |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal.AdminPostTaxRatesTaxRateReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-25.AdminPostTaxRatesTaxRateReq.md) |
|
||||
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-25.AdminGetTaxRatesTaxRateParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-25.md#admintaxratesres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L68)
|
||||
[medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/tax-rates.ts#L68)
|
||||
|
||||
@@ -20,24 +20,66 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/uploads.ts:7](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/uploads.ts#L7)
|
||||
[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/uploads.ts#L14)
|
||||
|
||||
## Methods
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadRes`](../modules/internal.md#adminuploadres)\>
|
||||
▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-26.md#adminuploadsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `file` | [`IAdminPostUploadsFile`](internal.IAdminPostUploadsFile.md) |
|
||||
| `file` | [`IAdminPostUploadsFileReq`](internal-26.IAdminPostUploadsFileReq.md) |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadRes`](../modules/internal.md#adminuploadres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-26.md#adminuploadsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/uploads.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/uploads.ts#L11)
|
||||
[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/uploads.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminDeleteUploadsReq`](internal-26.AdminDeleteUploadsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/uploads.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
### getPresignedDownloadUrl
|
||||
|
||||
▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-26.md#adminuploadsdownloadurlres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-26.AdminPostUploadsDownloadUrlReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-26.md#adminuploadsdownloadurlres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/uploads.ts#L36)
|
||||
|
||||
@@ -10,104 +10,112 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\>
|
||||
|
||||
**`description`** creates a user with the provided information
|
||||
**`Description`**
|
||||
|
||||
creates a user with the provided information
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminCreateUserPayload`](../modules/internal.md#admincreateuserpayload) | user creation request body |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminCreateUserPayload`](../modules/internal-27.md#admincreateuserpayload) | user creation request body |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\>
|
||||
|
||||
created user
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/users.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L61)
|
||||
[medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/users.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`description`** deletes a user
|
||||
**`Description`**
|
||||
|
||||
deletes a user
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the user to be deleted |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
delete response
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/users.ts:88](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L88)
|
||||
[medusa-js/src/resources/admin/users.ts:94](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/users.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal.md#adminuserslistres)\>
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-27.md#adminuserslistres)\>
|
||||
|
||||
**`description`** lists all users
|
||||
**`Description`**
|
||||
|
||||
lists all users
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal.md#adminuserslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-27.md#adminuserslistres)\>
|
||||
|
||||
a list of all users
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/users.ts:97](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L97)
|
||||
[medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/users.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
### resetPassword
|
||||
|
||||
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
|
||||
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\>
|
||||
|
||||
**`description`** resets the users password given the correct token.
|
||||
**`Description`**
|
||||
|
||||
resets the users password given the correct token.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminResetPasswordRequest`](internal.AdminResetPasswordRequest.md) | reset password information. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminResetPasswordRequest`](internal-27.AdminResetPasswordRequest.md) | reset password information. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L36)
|
||||
[medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/users.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\>
|
||||
|
||||
Retrieves a given user
|
||||
|
||||
@@ -116,17 +124,17 @@ Retrieves a given user
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the user |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\>
|
||||
|
||||
the user
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L50)
|
||||
[medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/users.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -134,14 +142,16 @@ ___
|
||||
|
||||
▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
|
||||
|
||||
**`description`** resets password by re-sending password token.
|
||||
**`Description`**
|
||||
|
||||
resets password by re-sending password token.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`AdminResetPasswordTokenRequest`](internal.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminResetPasswordTokenRequest`](internal-27.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -149,30 +159,32 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L22)
|
||||
[medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/users.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\>
|
||||
|
||||
**`description`** updates a given user
|
||||
**`Description`**
|
||||
|
||||
updates a given user
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the user to update |
|
||||
| `payload` | [`AdminUpdateUserPayload`](../modules/internal.md#adminupdateuserpayload) | user update request body |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`AdminUpdateUserPayload`](../modules/internal-27.md#adminupdateuserpayload) | user update request body |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-27.md#adminuserres)\>
|
||||
|
||||
the updated user
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/users.ts:73](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L73)
|
||||
[medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/users.ts#L79)
|
||||
|
||||
@@ -10,19 +10,19 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal.md#adminvariantslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-28.md#adminvariantslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`AdminGetVariantsParams`](internal.AdminGetVariantsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`AdminGetVariantsParams`](internal-28.AdminGetVariantsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal.md#adminvariantslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-28.md#adminvariantslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/variants.ts#L7)
|
||||
[medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/admin/variants.ts#L7)
|
||||
|
||||
@@ -10,67 +10,73 @@
|
||||
|
||||
### authenticate
|
||||
|
||||
▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\>
|
||||
▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-29.md#storeauthres)\>
|
||||
|
||||
**`description`** Authenticates a customer using email and password combination
|
||||
**`Description`**
|
||||
|
||||
Authenticates a customer using email and password combination
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostAuthReq`](internal.StorePostAuthReq.md) | authentication payload |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostAuthReq`](internal-29.StorePostAuthReq.md) | authentication payload |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-29.md#storeauthres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L16)
|
||||
[medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/auth.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### exists
|
||||
|
||||
▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal.md#storegetauthemailres)\>
|
||||
▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-29.md#storegetauthemailres)\>
|
||||
|
||||
**`description`** Check if email exists
|
||||
**`Description`**
|
||||
|
||||
Check if email exists
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `email` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal.md#storegetauthemailres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-29.md#storegetauthemailres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/auth.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L38)
|
||||
[medusa-js/src/resources/auth.ts:38](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/auth.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### getSession
|
||||
|
||||
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\>
|
||||
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-29.md#storeauthres)\>
|
||||
|
||||
**`description`** Retrieves an authenticated session
|
||||
**`Description`**
|
||||
|
||||
Retrieves an authenticated session
|
||||
Usually used to check if authenticated session is alive.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-29.md#storeauthres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/auth.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L27)
|
||||
[medusa-js/src/resources/auth.ts:27](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/auth.ts#L27)
|
||||
|
||||
@@ -14,13 +14,13 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L15)
|
||||
[medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L15)
|
||||
|
||||
## Methods
|
||||
|
||||
### addShippingMethod
|
||||
|
||||
▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Adds a shipping method to cart
|
||||
|
||||
@@ -29,22 +29,22 @@ Adds a shipping method to cart
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | Id of cart |
|
||||
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-30.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L24)
|
||||
[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### complete
|
||||
|
||||
▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal.md#storecompletecartres)\>
|
||||
▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-30.md#storecompletecartres)\>
|
||||
|
||||
Completes a cart.
|
||||
Payment authorization is attempted and if more work is required, we simply return the cart for further updates.
|
||||
@@ -57,21 +57,21 @@ If not provuided, we will generate one for the request.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal.md#storecompletecartres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-30.md#storecompletecartres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L43)
|
||||
[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Creates a cart
|
||||
|
||||
@@ -79,22 +79,22 @@ Creates a cart
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload?` | [`StorePostCartReq`](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`\> | |
|
||||
| `payload?` | [`StorePostCartReq`](internal-30.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L58)
|
||||
[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
### createPaymentSessions
|
||||
|
||||
▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Creates payment sessions.
|
||||
Initializes the payment sessions that can be used to pay for the items of the cart.
|
||||
@@ -105,21 +105,21 @@ This is usually called when a customer proceeds to checkout.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L74)
|
||||
[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
### deleteDiscount
|
||||
|
||||
▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Removes a discount from cart.
|
||||
|
||||
@@ -129,21 +129,21 @@ Removes a discount from cart.
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `code` | `string` | discount code to remove |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L89)
|
||||
[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
### deletePaymentSession
|
||||
|
||||
▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Removes a payment session from a cart.
|
||||
Can be useful in case a payment has failed
|
||||
@@ -154,21 +154,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`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L106)
|
||||
[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
### refreshPaymentSession
|
||||
|
||||
▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Refreshes a payment session.
|
||||
|
||||
@@ -178,21 +178,21 @@ Refreshes a payment session.
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `provider_id` | `string` | the provider id of the session e.g. "stripe" |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L122)
|
||||
[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L122)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Retrieves a cart
|
||||
|
||||
@@ -201,21 +201,21 @@ Retrieves a cart
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L137)
|
||||
[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L137)
|
||||
|
||||
___
|
||||
|
||||
### setPaymentSession
|
||||
|
||||
▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Refreshes a payment session.
|
||||
|
||||
@@ -224,22 +224,22 @@ Refreshes a payment session.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-30.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L152)
|
||||
[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L152)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Updates a cart
|
||||
|
||||
@@ -248,22 +248,22 @@ Updates a cart
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `payload` | [`StorePostCartsCartReq`](internal.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartReq`](internal-30.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L168)
|
||||
[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L168)
|
||||
|
||||
___
|
||||
|
||||
### updatePaymentSession
|
||||
|
||||
▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Updates the payment method
|
||||
|
||||
@@ -273,13 +273,13 @@ Updates the payment method
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `provider_id` | `string` | is required |
|
||||
| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal.StorePostCartsCartPaymentSessionUpdateReq.md) | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-30.StorePostCartsCartPaymentSessionUpdateReq.md) | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L185)
|
||||
[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/carts.ts#L185)
|
||||
|
||||
@@ -10,44 +10,48 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal.md#storecollectionslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-31.md#storecollectionslistres)\>
|
||||
|
||||
**`description`** Retrieves a list of collections
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of collections
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`StoreGetCollectionsParams`](internal.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`StoreGetCollectionsParams`](internal-31.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal.md#storecollectionslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-31.md#storecollectionslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/collections.ts#L28)
|
||||
[medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/collections.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal.md#storecollectionsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-31.md#storecollectionsres)\>
|
||||
|
||||
**`description`** Retrieves a single collection
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single collection
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the collection |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal.md#storecollectionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-31.md#storecollectionsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/collections.ts#L17)
|
||||
[medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/collections.ts#L17)
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L17)
|
||||
[medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/customers.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +24,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/customers.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L16)
|
||||
[medusa-js/src/resources/customers.ts:16](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/customers.ts#L16)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -38,8 +38,8 @@ Creates a customer
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersReq`](internal.StorePostCustomersReq.md) | information of customer |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersReq`](internal-32.StorePostCustomersReq.md) | information of customer |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -47,7 +47,7 @@ Creates a customer
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/customers.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L25)
|
||||
[medusa-js/src/resources/customers.ts:25](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/customers.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,8 +62,8 @@ The token is not returned but should be sent out to the customer in an email.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-32.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -71,13 +71,13 @@ The token is not returned but should be sent out to the customer in an email.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/customers.ts:100](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L100)
|
||||
[medusa-js/src/resources/customers.ts:100](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/customers.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
### listOrders
|
||||
|
||||
▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal.md#storecustomerslistordersres)\>
|
||||
▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-32.md#storecustomerslistordersres)\>
|
||||
|
||||
Retrieve customer orders
|
||||
|
||||
@@ -85,16 +85,16 @@ Retrieve customer orders
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-32.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal.md#storecustomerslistordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-32.md#storecustomerslistordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/customers.ts:65](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L65)
|
||||
[medusa-js/src/resources/customers.ts:65](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/customers.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,8 +108,8 @@ Resets customer password
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to reset customer password |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-32.StorePostCustomersCustomerPasswordTokenReq.md) | info used to reset customer password |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -117,7 +117,7 @@ Resets customer password
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/customers.ts:85](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L85)
|
||||
[medusa-js/src/resources/customers.ts:85](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/customers.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -131,7 +131,7 @@ Retrieves the customer that is currently logged
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -139,7 +139,7 @@ Retrieves the customer that is currently logged
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/customers.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L38)
|
||||
[medusa-js/src/resources/customers.ts:38](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/customers.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -153,8 +153,8 @@ Updates a customer
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostCustomersCustomerReq`](internal.StorePostCustomersCustomerReq.md) | information to update customer with |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCustomersCustomerReq`](internal-32.StorePostCustomersCustomerReq.md) | information to update customer with |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -162,4 +162,4 @@ Updates a customer
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/customers.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L51)
|
||||
[medusa-js/src/resources/customers.ts:51](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/customers.ts#L51)
|
||||
|
||||
@@ -10,21 +10,23 @@
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal.md#storegiftcardsres)\>
|
||||
▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-33.md#storegiftcardsres)\>
|
||||
|
||||
**`description`** Retrieves a single GiftCard
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single GiftCard
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `code` | `string` | code of the gift card |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal.md#storegiftcardsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-33.md#storegiftcardsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/gift-cards.ts#L12)
|
||||
[medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/gift-cards.ts#L12)
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Creates a line-item for a cart
|
||||
|
||||
@@ -19,22 +19,22 @@ Creates a line-item for a cart
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | id of cart |
|
||||
| `payload` | [`StorePostCartsCartLineItemsReq`](internal.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartLineItemsReq`](internal-34.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L17)
|
||||
[medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/line-items.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Remove a line-item from a cart
|
||||
|
||||
@@ -44,21 +44,21 @@ Remove a line-item from a cart
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | id of cart |
|
||||
| `line_id` | `string` | id of item to remove |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L50)
|
||||
[medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/e38dd7f6/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.md#storecartsres)\>
|
||||
▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
Updates a line-item.
|
||||
Only quantity updates are allowed
|
||||
@@ -69,13 +69,13 @@ Only quantity updates are allowed
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | id of cart |
|
||||
| `line_id` | `string` | id of item to update |
|
||||
| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-34.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-30.md#storecartsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L34)
|
||||
[medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/line-items.ts#L34)
|
||||
|
||||
@@ -10,67 +10,73 @@
|
||||
|
||||
### lookupOrder
|
||||
|
||||
▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
|
||||
▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
|
||||
|
||||
**`description`** Look up an order using order details
|
||||
**`Description`**
|
||||
|
||||
Look up an order using order details
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StoreGetOrdersParams`](internal.StoreGetOrdersParams.md) | details used to look up the order |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StoreGetOrdersParams`](internal-35.StoreGetOrdersParams.md) | details used to look up the order |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/orders.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L35)
|
||||
[medusa-js/src/resources/orders.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/orders.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
|
||||
|
||||
**`description`** Retrieves an order
|
||||
**`Description`**
|
||||
|
||||
Retrieves an order
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L13)
|
||||
[medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/orders.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCartId
|
||||
|
||||
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
|
||||
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
|
||||
|
||||
**`description`** Retrieves an order by cart id
|
||||
**`Description`**
|
||||
|
||||
Retrieves an order by cart id
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-35.md#storeordersres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/orders.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L24)
|
||||
[medusa-js/src/resources/orders.ts:27](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/orders.ts#L27)
|
||||
|
||||
@@ -10,21 +10,20 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal.md#storecustomerslistpaymentmethodsres)\>
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-36.md#storecustomerslistpaymentmethodsres)\>
|
||||
|
||||
Lists customer payment methods
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of cart |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal.md#storecustomerslistpaymentmethodsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-36.md#storecustomerslistpaymentmethodsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/payment-methods.ts#L12)
|
||||
[medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/payment-methods.ts#L12)
|
||||
|
||||
@@ -10,44 +10,48 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal.md#storevariantslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-37.md#storevariantslistres)\>
|
||||
|
||||
**`description`** Retrieves a list of of Product Variants
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of of Product Variants
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`StoreGetVariantsParams`](internal.StoreGetVariantsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`StoreGetVariantsParams`](internal-37.StoreGetVariantsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal.md#storevariantslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-37.md#storevariantslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/product-variants.ts#L28)
|
||||
[medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/product-variants.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal.md#storevariantsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-37.md#storevariantsres)\>
|
||||
|
||||
**`description`** Retrieves a single product variant
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single product variant
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal.md#storevariantsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-37.md#storevariantsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/product-variants.ts#L17)
|
||||
[medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/product-variants.ts#L17)
|
||||
|
||||
@@ -14,73 +14,79 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L14)
|
||||
[medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/products.ts#L14)
|
||||
|
||||
## Methods
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal.md#storeproductslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-38.md#storeproductslistres)\>
|
||||
|
||||
**`description`** Retrieves a list of products
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of products
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`StoreGetProductsParams`](internal.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `query?` | [`StoreGetProductsParams`](internal-38.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal.md#storeproductslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-38.md#storeproductslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/products.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L47)
|
||||
[medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/products.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal.md#storeproductsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-38.md#storeproductsres)\>
|
||||
|
||||
**`description`** Retrieves a single Product
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single Product
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal.md#storeproductsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-38.md#storeproductsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L22)
|
||||
[medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/products.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### search
|
||||
|
||||
▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal.md#storepostsearchres)\>
|
||||
▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-38.md#storepostsearchres)\>
|
||||
|
||||
**`description`** Searches for products
|
||||
**`Description`**
|
||||
|
||||
Searches for products
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `searchOptions` | [`StorePostSearchReq`](internal.StorePostSearchReq.md) | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `searchOptions` | [`StorePostSearchReq`](internal-38.StorePostSearchReq.md) | is required |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal.md#storepostsearchres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-38.md#storepostsearchres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/products.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L33)
|
||||
[medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/products.ts#L36)
|
||||
|
||||
@@ -10,43 +10,47 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal.md#storeregionslistres)\>
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-39.md#storeregionslistres)\>
|
||||
|
||||
**`description`** Retrieves a list of regions
|
||||
**`Description`**
|
||||
|
||||
Retrieves a list of regions
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal.md#storeregionslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-39.md#storeregionslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/regions.ts#L11)
|
||||
[medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/regions.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal.md#storeregionsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-39.md#storeregionsres)\>
|
||||
|
||||
**`description`** Retrieves a region
|
||||
**`Description`**
|
||||
|
||||
Retrieves a region
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal.md#storeregionsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-39.md#storeregionsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/regions.ts#L22)
|
||||
[medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/regions.ts#L22)
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal.md#storereturnreasonslistres)\>
|
||||
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-40.md#storereturnreasonslistres)\>
|
||||
|
||||
Lists return reasons defined in Medusa Admin
|
||||
|
||||
@@ -18,35 +18,37 @@ Lists return reasons defined in Medusa Admin
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal.md#storereturnreasonslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-40.md#storereturnreasonslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/return-reasons.ts#L25)
|
||||
[medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/return-reasons.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal.md#storereturnreasonsres)\>
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-40.md#storereturnreasonsres)\>
|
||||
|
||||
**`description`** Retrieves a single Return Reason
|
||||
**`Description`**
|
||||
|
||||
Retrieves a single Return Reason
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | is required |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal.md#storereturnreasonsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-40.md#storereturnreasonsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/return-reasons.ts#L15)
|
||||
[medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/return-reasons.ts#L15)
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal.md#storereturnsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-41.md#storereturnsres)\>
|
||||
|
||||
Creates a return request
|
||||
|
||||
@@ -18,13 +18,13 @@ Creates a return request
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `payload` | [`StorePostReturnsReq`](internal.StorePostReturnsReq.md) | details needed to create a return |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `payload` | [`StorePostReturnsReq`](internal-41.StorePostReturnsReq.md) | details needed to create a return |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal.md#storereturnsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-41.md#storereturnsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/returns.ts#L12)
|
||||
[medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/returns.ts#L12)
|
||||
|
||||
@@ -10,44 +10,48 @@
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\>
|
||||
|
||||
**`description`** Lists shiping options available
|
||||
**`Description`**
|
||||
|
||||
Lists shiping options available
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `query?` | [`StoreGetShippingOptionsParams`](internal.StoreGetShippingOptionsParams.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `query?` | [`StoreGetShippingOptionsParams`](internal-42.StoreGetShippingOptionsParams.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/shipping-options.ts#L27)
|
||||
[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/shipping-options.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
### listCartOptions
|
||||
|
||||
▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
|
||||
▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\>
|
||||
|
||||
**`description`** Lists shiping options available for a cart
|
||||
**`Description`**
|
||||
|
||||
Lists shiping options available for a cart
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `cart_id` | `string` |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-42.md#storeshippingoptionslistres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/shipping-options.ts#L16)
|
||||
[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/shipping-options.ts#L16)
|
||||
|
||||
@@ -10,44 +10,48 @@
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\>
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\>
|
||||
|
||||
**`description`** Creates a swap from a cart
|
||||
**`Description`**
|
||||
|
||||
Creates a swap from a cart
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`StorePostSwapsReq`](internal.StorePostSwapsReq.md) |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
| `payload` | [`StorePostSwapsReq`](internal-43.StorePostSwapsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/swaps.ts#L12)
|
||||
[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/swaps.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
### retrieveByCartId
|
||||
|
||||
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\>
|
||||
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\>
|
||||
|
||||
**`description`** Retrieves a swap by cart id
|
||||
**`Description`**
|
||||
|
||||
Retrieves a swap by cart id
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `cart_id` | `string` | id of cart |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\>
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-43.md#storeswapsres)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/swaps.ts#L23)
|
||||
[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/resources/swaps.ts#L23)
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: AdminPostAuthReq
|
||||
|
||||
[internal](../modules/internal-1.md).AdminPostAuthReq
|
||||
|
||||
## Properties
|
||||
|
||||
### email
|
||||
|
||||
• **email**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/auth/create-session.d.ts:25
|
||||
|
||||
___
|
||||
|
||||
### password
|
||||
|
||||
• **password**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/auth/create-session.d.ts:26
|
||||
@@ -1,10 +1,8 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: User
|
||||
|
||||
[internal](../modules/internal.md).User
|
||||
[internal](../modules/internal-1.md).User
|
||||
|
||||
Base abstract entity for all entities
|
||||
|
||||
## Hierarchy
|
||||
|
||||
@@ -20,7 +18,7 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:13
|
||||
medusa/dist/models/user.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
@@ -30,13 +28,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:15
|
||||
medusa/dist/models/user.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: [`Date`](../modules/internal.md#date)
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -44,13 +42,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:6
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### deleted\_at
|
||||
|
||||
• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date)
|
||||
• **deleted\_at**: ``null`` \| `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -58,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
|
||||
medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
|
||||
|
||||
___
|
||||
|
||||
@@ -68,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:9
|
||||
medusa/dist/models/user.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:10
|
||||
medusa/dist/models/user.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +90,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:5
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
@@ -102,17 +100,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:11
|
||||
medusa/dist/models/user.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:14
|
||||
medusa/dist/models/user.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
@@ -122,23 +120,23 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:12
|
||||
medusa/dist/models/user.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### role
|
||||
|
||||
• **role**: [`UserRoles`](../enums/internal.UserRoles.md)
|
||||
• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:8
|
||||
medusa/dist/models/user.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: [`Date`](../modules/internal.md#date)
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -146,4 +144,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
@@ -0,0 +1,33 @@
|
||||
# Class: AdminGetNotesParams
|
||||
|
||||
[internal](../modules/internal-10.md).AdminGetNotesParams
|
||||
|
||||
## Properties
|
||||
|
||||
### limit
|
||||
|
||||
• **limit**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/list-notes.d.ts:29
|
||||
|
||||
___
|
||||
|
||||
### offset
|
||||
|
||||
• **offset**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/list-notes.d.ts:30
|
||||
|
||||
___
|
||||
|
||||
### resource\_id
|
||||
|
||||
• `Optional` **resource\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/list-notes.d.ts:28
|
||||
@@ -0,0 +1,13 @@
|
||||
# Class: AdminPostNotesNoteReq
|
||||
|
||||
[internal](../modules/internal-10.md).AdminPostNotesNoteReq
|
||||
|
||||
## Properties
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/update-note.d.ts:35
|
||||
@@ -0,0 +1,33 @@
|
||||
# Class: AdminPostNotesReq
|
||||
|
||||
[internal](../modules/internal-10.md).AdminPostNotesReq
|
||||
|
||||
## Properties
|
||||
|
||||
### resource\_id
|
||||
|
||||
• **resource\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/create-note.d.ts:37
|
||||
|
||||
___
|
||||
|
||||
### resource\_type
|
||||
|
||||
• **resource\_type**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/create-note.d.ts:38
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/create-note.d.ts:39
|
||||
@@ -1,10 +1,8 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: Note
|
||||
|
||||
[internal](../modules/internal.md).Note
|
||||
[internal](../modules/internal-10.md).Note
|
||||
|
||||
Base abstract entity for all entities
|
||||
|
||||
## Hierarchy
|
||||
|
||||
@@ -16,11 +14,11 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
### author
|
||||
|
||||
• **author**: [`User`](internal.User.md)
|
||||
• **author**: [`User`](internal-1.User.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/note.d.ts:8
|
||||
medusa/dist/models/note.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
@@ -30,7 +28,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/note.d.ts:7
|
||||
medusa/dist/models/note.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
@@ -40,13 +38,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/note.d.ts:10
|
||||
medusa/dist/models/note.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: [`Date`](../modules/internal.md#date)
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -54,13 +52,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:6
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### deleted\_at
|
||||
|
||||
• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date)
|
||||
• **deleted\_at**: ``null`` \| `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -68,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
|
||||
medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
|
||||
|
||||
___
|
||||
|
||||
@@ -82,17 +80,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:5
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/note.d.ts:9
|
||||
medusa/dist/models/note.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +100,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/note.d.ts:6
|
||||
medusa/dist/models/note.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
@@ -112,13 +110,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/note.d.ts:5
|
||||
medusa/dist/models/note.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: [`Date`](../modules/internal.md#date)
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -126,7 +124,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
@@ -136,4 +134,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/note.d.ts:4
|
||||
medusa/dist/models/note.d.ts:4
|
||||
@@ -0,0 +1,93 @@
|
||||
# Class: AdminGetNotificationsParams
|
||||
|
||||
[internal](../modules/internal-11.md).AdminGetNotificationsParams
|
||||
|
||||
## Properties
|
||||
|
||||
### event\_name
|
||||
|
||||
• `Optional` **event\_name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:38
|
||||
|
||||
___
|
||||
|
||||
### expand
|
||||
|
||||
• `Optional` **expand**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:37
|
||||
|
||||
___
|
||||
|
||||
### fields
|
||||
|
||||
• `Optional` **fields**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:36
|
||||
|
||||
___
|
||||
|
||||
### include\_resends
|
||||
|
||||
• `Optional` **include\_resends**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:42
|
||||
|
||||
___
|
||||
|
||||
### limit
|
||||
|
||||
• `Optional` **limit**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:34
|
||||
|
||||
___
|
||||
|
||||
### offset
|
||||
|
||||
• `Optional` **offset**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:35
|
||||
|
||||
___
|
||||
|
||||
### resource\_id
|
||||
|
||||
• `Optional` **resource\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:40
|
||||
|
||||
___
|
||||
|
||||
### resource\_type
|
||||
|
||||
• `Optional` **resource\_type**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:39
|
||||
|
||||
___
|
||||
|
||||
### to
|
||||
|
||||
• `Optional` **to**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:41
|
||||
@@ -0,0 +1,13 @@
|
||||
# Class: AdminPostNotificationsNotificationResendReq
|
||||
|
||||
[internal](../modules/internal-11.md).AdminPostNotificationsNotificationResendReq
|
||||
|
||||
## Properties
|
||||
|
||||
### to
|
||||
|
||||
• `Optional` **to**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notifications/resend-notification.d.ts:32
|
||||
@@ -1,10 +1,8 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: Notification
|
||||
|
||||
[internal](../modules/internal.md).Notification
|
||||
[internal](../modules/internal-11.md).Notification
|
||||
|
||||
Base abstract entity for all entities
|
||||
|
||||
## Hierarchy
|
||||
|
||||
@@ -20,13 +18,13 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:17
|
||||
medusa/dist/models/notification.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: [`Date`](../modules/internal.md#date)
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -34,7 +32,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:6
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
@@ -44,27 +42,27 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:9
|
||||
medusa/dist/models/notification.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• **customer\_id**: `string`
|
||||
• **customer\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:8
|
||||
medusa/dist/models/notification.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
|
||||
• **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:11
|
||||
medusa/dist/models/notification.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +72,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:5
|
||||
medusa/dist/models/notification.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:5
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
@@ -98,27 +96,27 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:12
|
||||
medusa/dist/models/notification.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### parent\_notification
|
||||
|
||||
• **parent\_notification**: [`Notification`](internal.Notification.md)
|
||||
• **parent\_notification**: [`Notification`](internal-11.Notification.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:13
|
||||
medusa/dist/models/notification.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### provider
|
||||
|
||||
• **provider**: [`NotificationProvider`](internal.NotificationProvider.md)
|
||||
• **provider**: [`NotificationProvider`](internal-11.NotificationProvider.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:16
|
||||
medusa/dist/models/notification.d.ts:16
|
||||
|
||||
___
|
||||
|
||||
@@ -128,17 +126,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:15
|
||||
medusa/dist/models/notification.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### resends
|
||||
|
||||
• **resends**: [`Notification`](internal.Notification.md)[]
|
||||
• **resends**: [`Notification`](internal-11.Notification.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:14
|
||||
medusa/dist/models/notification.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
@@ -148,7 +146,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:7
|
||||
medusa/dist/models/notification.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
@@ -158,7 +156,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:6
|
||||
medusa/dist/models/notification.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
@@ -168,13 +166,13 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/notification.d.ts:10
|
||||
medusa/dist/models/notification.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: [`Date`](../modules/internal.md#date)
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -182,4 +180,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: NotificationProvider
|
||||
|
||||
[internal](../modules/internal-11.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
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: AdditionalItem
|
||||
|
||||
[internal](../modules/internal-12.md).AdditionalItem
|
||||
|
||||
## Properties
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:148
|
||||
|
||||
___
|
||||
|
||||
### variant\_id
|
||||
|
||||
• **variant\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:147
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: AdditionalItem
|
||||
|
||||
[internal](../modules/internal-12.md).AdditionalItem
|
||||
|
||||
## Properties
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:112
|
||||
|
||||
___
|
||||
|
||||
### variant\_id
|
||||
|
||||
• **variant\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:111
|
||||
@@ -0,0 +1,273 @@
|
||||
# Class: AdminGetOrdersParams
|
||||
|
||||
[internal](../modules/internal-12.md).AdminGetOrdersParams
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`AdminListOrdersSelector`](internal-12.AdminListOrdersSelector.md)
|
||||
|
||||
↳ **`AdminGetOrdersParams`**
|
||||
|
||||
## Properties
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[canceled_at](internal-12.AdminListOrdersSelector.md#canceled_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:93
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• `Optional` **cart\_id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[cart_id](internal-12.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-12.AdminListOrdersSelector.md).[created_at](internal-12.AdminListOrdersSelector.md#created_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:94
|
||||
|
||||
___
|
||||
|
||||
### currency\_code
|
||||
|
||||
• `Optional` **currency\_code**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[currency_code](internal-12.AdminListOrdersSelector.md#currency_code)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• `Optional` **customer\_id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[customer_id](internal-12.AdminListOrdersSelector.md#customer_id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### display\_id
|
||||
|
||||
• `Optional` **display\_id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[display_id](internal-12.AdminListOrdersSelector.md#display_id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:85
|
||||
|
||||
___
|
||||
|
||||
### email
|
||||
|
||||
• `Optional` **email**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[email](internal-12.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:48
|
||||
|
||||
___
|
||||
|
||||
### fields
|
||||
|
||||
• `Optional` **fields**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/list-orders.d.ts:49
|
||||
|
||||
___
|
||||
|
||||
### fulfillment\_status
|
||||
|
||||
• `Optional` **fulfillment\_status**: `string`[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[fulfillment_status](internal-12.AdminListOrdersSelector.md#fulfillment_status)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:83
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• `Optional` **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[id](internal-12.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:47
|
||||
|
||||
___
|
||||
|
||||
### offset
|
||||
|
||||
• **offset**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/list-orders.d.ts:46
|
||||
|
||||
___
|
||||
|
||||
### payment\_status
|
||||
|
||||
• `Optional` **payment\_status**: `string`[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[payment_status](internal-12.AdminListOrdersSelector.md#payment_status)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### q
|
||||
|
||||
• `Optional` **q**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[q](internal-12.AdminListOrdersSelector.md#q)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:80
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• `Optional` **region\_id**: `string` \| `string`[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[region_id](internal-12.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-12.AdminListOrdersSelector.md).[sales_channel_id](internal-12.AdminListOrdersSelector.md#sales_channel_id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:92
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• `Optional` **status**: `string`[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[status](internal-12.AdminListOrdersSelector.md#status)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:82
|
||||
|
||||
___
|
||||
|
||||
### tax\_rate
|
||||
|
||||
• `Optional` **tax\_rate**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[AdminListOrdersSelector](internal-12.AdminListOrdersSelector.md).[tax_rate](internal-12.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-12.AdminListOrdersSelector.md).[updated_at](internal-12.AdminListOrdersSelector.md#updated_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:95
|
||||
@@ -1,26 +1,22 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminListOrdersSelector
|
||||
|
||||
[internal](../modules/internal.md).AdminListOrdersSelector
|
||||
[internal](../modules/internal-12.md).AdminListOrdersSelector
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- **`AdminListOrdersSelector`**
|
||||
|
||||
↳ [`AdminGetOrdersParams`](internal.AdminGetOrdersParams.md)
|
||||
↳ [`AdminGetOrdersParams`](internal-12.AdminGetOrdersParams.md)
|
||||
|
||||
## Properties
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:17
|
||||
medusa/dist/types/orders.d.ts:93
|
||||
|
||||
___
|
||||
|
||||
@@ -30,17 +26,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:11
|
||||
medusa/dist/types/orders.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:18
|
||||
medusa/dist/types/orders.d.ts:94
|
||||
|
||||
___
|
||||
|
||||
@@ -50,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:15
|
||||
medusa/dist/types/orders.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
@@ -60,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:12
|
||||
medusa/dist/types/orders.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
@@ -70,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:10
|
||||
medusa/dist/types/orders.d.ts:85
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:13
|
||||
medusa/dist/types/orders.d.ts:88
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:8
|
||||
medusa/dist/types/orders.d.ts:83
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:6
|
||||
medusa/dist/types/orders.d.ts:81
|
||||
|
||||
___
|
||||
|
||||
@@ -110,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:9
|
||||
medusa/dist/types/orders.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
@@ -120,17 +116,27 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:5
|
||||
medusa/dist/types/orders.d.ts:80
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• `Optional` **region\_id**: `string`
|
||||
• `Optional` **region\_id**: `string` \| `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:14
|
||||
medusa/dist/types/orders.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### sales\_channel\_id
|
||||
|
||||
• `Optional` **sales\_channel\_id**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/orders.d.ts:92
|
||||
|
||||
___
|
||||
|
||||
@@ -140,7 +146,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:7
|
||||
medusa/dist/types/orders.d.ts:82
|
||||
|
||||
___
|
||||
|
||||
@@ -150,14 +156,14 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:16
|
||||
medusa/dist/types/orders.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:19
|
||||
medusa/dist/types/orders.d.ts:95
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: AdminPostOrdersOrderClaimsClaimFulfillmentsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderClaimsClaimFulfillmentsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### metadata
|
||||
|
||||
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:36
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:37
|
||||
@@ -0,0 +1,43 @@
|
||||
# Class: AdminPostOrdersOrderClaimsClaimReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderClaimsClaimReq
|
||||
|
||||
## Properties
|
||||
|
||||
### claim\_items
|
||||
|
||||
• `Optional` **claim\_items**: [`Item`](internal-12.Item-2.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### shipping\_methods
|
||||
|
||||
• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-12.ShippingMethod-2.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:85
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: AdminPostOrdersOrderClaimsClaimShipmentsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderClaimsClaimShipmentsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### fulfillment\_id
|
||||
|
||||
• **fulfillment\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:40
|
||||
|
||||
___
|
||||
|
||||
### tracking\_numbers
|
||||
|
||||
• `Optional` **tracking\_numbers**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:41
|
||||
@@ -0,0 +1,93 @@
|
||||
# Class: AdminPostOrdersOrderClaimsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderClaimsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### additional\_items
|
||||
|
||||
• `Optional` **additional\_items**: [`AdditionalItem`](internal-12.AdditionalItem-1.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:122
|
||||
|
||||
___
|
||||
|
||||
### claim\_items
|
||||
|
||||
• **claim\_items**: [`Item`](internal-12.Item-1.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:120
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• `Optional` **metadata**: `object`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:127
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:126
|
||||
|
||||
___
|
||||
|
||||
### refund\_amount
|
||||
|
||||
• `Optional` **refund\_amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:124
|
||||
|
||||
___
|
||||
|
||||
### return\_shipping
|
||||
|
||||
• `Optional` **return\_shipping**: [`ReturnShipping`](internal-12.ReturnShipping-2.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:121
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address
|
||||
|
||||
• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:125
|
||||
|
||||
___
|
||||
|
||||
### shipping\_methods
|
||||
|
||||
• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-12.ShippingMethod-1.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:123
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: ``"refund"`` \| ``"replace"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:119
|
||||
@@ -0,0 +1,33 @@
|
||||
# Class: AdminPostOrdersOrderFulfillmentsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderFulfillmentsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### items
|
||||
|
||||
• **items**: [`Item`](internal-12.Item.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:48
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:50
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:49
|
||||
@@ -0,0 +1,43 @@
|
||||
# Class: AdminPostOrdersOrderRefundsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderRefundsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### amount
|
||||
|
||||
• **amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/refund-payment.d.ts:44
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/refund-payment.d.ts:47
|
||||
|
||||
___
|
||||
|
||||
### note
|
||||
|
||||
• `Optional` **note**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/refund-payment.d.ts:46
|
||||
|
||||
___
|
||||
|
||||
### reason
|
||||
|
||||
• **reason**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/refund-payment.d.ts:45
|
||||
@@ -0,0 +1,103 @@
|
||||
# Class: AdminPostOrdersOrderReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderReq
|
||||
|
||||
## Properties
|
||||
|
||||
### billing\_address
|
||||
|
||||
• `Optional` **billing\_address**: [`AddressPayload`](internal.AddressPayload.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• `Optional` **customer\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### discounts
|
||||
|
||||
• `Optional` **discounts**: `Record`<`string`, `unknown`\>[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
### email
|
||||
|
||||
• `Optional` **email**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:85
|
||||
|
||||
___
|
||||
|
||||
### items
|
||||
|
||||
• `Optional` **items**: `Record`<`string`, `unknown`\>[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:88
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:94
|
||||
|
||||
___
|
||||
|
||||
### payment\_method
|
||||
|
||||
• `Optional` **payment\_method**: [`PaymentMethod`](internal-12.PaymentMethod.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:92
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• `Optional` **region**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address
|
||||
|
||||
• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### shipping\_method
|
||||
|
||||
• `Optional` **shipping\_method**: [`ShippingMethod`](internal-12.ShippingMethod.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:93
|
||||
@@ -0,0 +1,63 @@
|
||||
# Class: AdminPostOrdersOrderReturnsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderReturnsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### items
|
||||
|
||||
• **items**: [`OrdersReturnItem`](internal-12.OrdersReturnItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:68
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:72
|
||||
|
||||
___
|
||||
|
||||
### note
|
||||
|
||||
• `Optional` **note**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:70
|
||||
|
||||
___
|
||||
|
||||
### receive\_now
|
||||
|
||||
• `Optional` **receive\_now**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:71
|
||||
|
||||
___
|
||||
|
||||
### refund
|
||||
|
||||
• `Optional` **refund**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:73
|
||||
|
||||
___
|
||||
|
||||
### return\_shipping
|
||||
|
||||
• `Optional` **return\_shipping**: [`ReturnShipping`](internal-12.ReturnShipping.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:69
|
||||
@@ -1,10 +1,6 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminPostOrdersOrderShipmentReq
|
||||
|
||||
[internal](../modules/internal.md).AdminPostOrdersOrderShipmentReq
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderShipmentReq
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:42
|
||||
medusa/dist/api/routes/admin/orders/create-shipment.d.ts:42
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +20,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:44
|
||||
medusa/dist/api/routes/admin/orders/create-shipment.d.ts:44
|
||||
|
||||
___
|
||||
|
||||
@@ -34,4 +30,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:43
|
||||
medusa/dist/api/routes/admin/orders/create-shipment.d.ts:43
|
||||
@@ -0,0 +1,33 @@
|
||||
# Class: AdminPostOrdersOrderShippingMethodsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderShippingMethodsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### data
|
||||
|
||||
• `Optional` **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:29
|
||||
|
||||
___
|
||||
|
||||
### option\_id
|
||||
|
||||
• **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:28
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:27
|
||||
@@ -0,0 +1,63 @@
|
||||
# Class: AdminPostOrdersOrderSwapsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderSwapsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### additional\_items
|
||||
|
||||
• `Optional` **additional\_items**: [`AdditionalItem`](internal-12.AdditionalItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### allow\_backorder
|
||||
|
||||
• `Optional` **allow\_backorder**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:94
|
||||
|
||||
___
|
||||
|
||||
### custom\_shipping\_options
|
||||
|
||||
• `Optional` **custom\_shipping\_options**: [`CustomShippingOption`](internal-12.CustomShippingOption.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:92
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:93
|
||||
|
||||
___
|
||||
|
||||
### return\_items
|
||||
|
||||
• **return\_items**: [`ReturnItem`](internal-12.ReturnItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:89
|
||||
|
||||
___
|
||||
|
||||
### return\_shipping
|
||||
|
||||
• `Optional` **return\_shipping**: [`ReturnShipping`](internal-12.ReturnShipping-1.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:90
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderSwapsSwapFulfillmentsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### metadata
|
||||
|
||||
• `Optional` **metadata**: `object`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:36
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:37
|
||||
@@ -0,0 +1,33 @@
|
||||
# Class: AdminPostOrdersOrderSwapsSwapShipmentsReq
|
||||
|
||||
[internal](../modules/internal-12.md).AdminPostOrdersOrderSwapsSwapShipmentsReq
|
||||
|
||||
## Properties
|
||||
|
||||
### fulfillment\_id
|
||||
|
||||
• **fulfillment\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:43
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• `Optional` **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:45
|
||||
|
||||
___
|
||||
|
||||
### tracking\_numbers
|
||||
|
||||
• `Optional` **tracking\_numbers**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:44
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: CustomShippingOption
|
||||
|
||||
[internal](../modules/internal-12.md).CustomShippingOption
|
||||
|
||||
## Properties
|
||||
|
||||
### option\_id
|
||||
|
||||
• **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:107
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:108
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: Image
|
||||
|
||||
[internal](../modules/internal-12.md).Image
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• `Optional` **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:103
|
||||
|
||||
___
|
||||
|
||||
### url
|
||||
|
||||
• `Optional` **url**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:104
|
||||
@@ -0,0 +1,63 @@
|
||||
# Class: Item
|
||||
|
||||
[internal](../modules/internal-12.md).Item
|
||||
|
||||
## Properties
|
||||
|
||||
### images
|
||||
|
||||
• `Optional` **images**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:144
|
||||
|
||||
___
|
||||
|
||||
### item\_id
|
||||
|
||||
• **item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:139
|
||||
|
||||
___
|
||||
|
||||
### note
|
||||
|
||||
• `Optional` **note**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:141
|
||||
|
||||
___
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:140
|
||||
|
||||
___
|
||||
|
||||
### reason
|
||||
|
||||
• `Optional` **reason**: [`ClaimReason`](../enums/internal.ClaimReason.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:142
|
||||
|
||||
___
|
||||
|
||||
### tags
|
||||
|
||||
• `Optional` **tags**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:143
|
||||
@@ -0,0 +1,63 @@
|
||||
# Class: Item
|
||||
|
||||
[internal](../modules/internal-12.md).Item
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:95
|
||||
|
||||
___
|
||||
|
||||
### images
|
||||
|
||||
• **images**: [`Image`](internal-12.Image.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:98
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• `Optional` **metadata**: `object`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:100
|
||||
|
||||
___
|
||||
|
||||
### note
|
||||
|
||||
• `Optional` **note**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:96
|
||||
|
||||
___
|
||||
|
||||
### reason
|
||||
|
||||
• `Optional` **reason**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:97
|
||||
|
||||
___
|
||||
|
||||
### tags
|
||||
|
||||
• **tags**: [`Tag`](internal-12.Tag.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:99
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: Item
|
||||
|
||||
[internal](../modules/internal-12.md).Item
|
||||
|
||||
## Properties
|
||||
|
||||
### item\_id
|
||||
|
||||
• **item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:53
|
||||
|
||||
___
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:54
|
||||
@@ -1,10 +1,6 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: OrdersReturnItem
|
||||
|
||||
[internal](../modules/internal.md).OrdersReturnItem
|
||||
[internal](../modules/internal-12.md).OrdersReturnItem
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:22
|
||||
medusa/dist/types/orders.d.ts:98
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +20,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:25
|
||||
medusa/dist/types/orders.d.ts:101
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +30,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:23
|
||||
medusa/dist/types/orders.d.ts:99
|
||||
|
||||
___
|
||||
|
||||
@@ -44,4 +40,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/orders.d.ts:24
|
||||
medusa/dist/types/orders.d.ts:100
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: PaymentMethod
|
||||
|
||||
[internal](../modules/internal-12.md).PaymentMethod
|
||||
|
||||
## Properties
|
||||
|
||||
### data
|
||||
|
||||
• `Optional` **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:98
|
||||
|
||||
___
|
||||
|
||||
### provider\_id
|
||||
|
||||
• `Optional` **provider\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:97
|
||||
@@ -0,0 +1,43 @@
|
||||
# Class: ReturnItem
|
||||
|
||||
[internal](../modules/internal-12.md).ReturnItem
|
||||
|
||||
## Properties
|
||||
|
||||
### item\_id
|
||||
|
||||
• **item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:97
|
||||
|
||||
___
|
||||
|
||||
### note
|
||||
|
||||
• `Optional` **note**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:100
|
||||
|
||||
___
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:98
|
||||
|
||||
___
|
||||
|
||||
### reason\_id
|
||||
|
||||
• `Optional` **reason\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:99
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: ReturnShipping
|
||||
|
||||
[internal](../modules/internal-12.md).ReturnShipping
|
||||
|
||||
## Properties
|
||||
|
||||
### option\_id
|
||||
|
||||
• **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:103
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• `Optional` **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-swap.d.ts:104
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: ReturnShipping
|
||||
|
||||
[internal](../modules/internal-12.md).ReturnShipping
|
||||
|
||||
## Properties
|
||||
|
||||
### option\_id
|
||||
|
||||
• `Optional` **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:130
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• `Optional` **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:131
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: ReturnShipping
|
||||
|
||||
[internal](../modules/internal-12.md).ReturnShipping
|
||||
|
||||
## Properties
|
||||
|
||||
### option\_id
|
||||
|
||||
• `Optional` **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:76
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• `Optional` **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/request-return.d.ts:77
|
||||
@@ -0,0 +1,33 @@
|
||||
# Class: ShippingMethod
|
||||
|
||||
[internal](../modules/internal-12.md).ShippingMethod
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• `Optional` **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:134
|
||||
|
||||
___
|
||||
|
||||
### option\_id
|
||||
|
||||
• `Optional` **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:135
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• `Optional` **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/create-claim.d.ts:136
|
||||
@@ -0,0 +1,33 @@
|
||||
# Class: ShippingMethod
|
||||
|
||||
[internal](../modules/internal-12.md).ShippingMethod
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• `Optional` **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
### option\_id
|
||||
|
||||
• `Optional` **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• `Optional` **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:92
|
||||
@@ -0,0 +1,53 @@
|
||||
# Class: ShippingMethod
|
||||
|
||||
[internal](../modules/internal-12.md).ShippingMethod
|
||||
|
||||
## Properties
|
||||
|
||||
### data
|
||||
|
||||
• `Optional` **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:104
|
||||
|
||||
___
|
||||
|
||||
### items
|
||||
|
||||
• `Optional` **items**: `Record`<`string`, `unknown`\>[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:105
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• `Optional` **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:103
|
||||
|
||||
___
|
||||
|
||||
### profile\_id
|
||||
|
||||
• `Optional` **profile\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:102
|
||||
|
||||
___
|
||||
|
||||
### provider\_id
|
||||
|
||||
• `Optional` **provider\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-order.d.ts:101
|
||||
23
docs/content/references/js-client/classes/internal-12.Tag.md
Normal file
23
docs/content/references/js-client/classes/internal-12.Tag.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Class: Tag
|
||||
|
||||
[internal](../modules/internal-12.md).Tag
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• `Optional` **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:107
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• `Optional` **value**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/update-claim.d.ts:108
|
||||
@@ -0,0 +1,13 @@
|
||||
# Class: AdminDeletePriceListPricesPricesReq
|
||||
|
||||
[internal](../modules/internal-13.md).AdminDeletePriceListPricesPricesReq
|
||||
|
||||
## Properties
|
||||
|
||||
### price\_ids
|
||||
|
||||
• **price\_ids**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts:42
|
||||
@@ -0,0 +1,189 @@
|
||||
# Class: AdminGetPriceListPaginationParams
|
||||
|
||||
[internal](../modules/internal-13.md).AdminGetPriceListPaginationParams
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`FilterablePriceListProps`](internal-13.FilterablePriceListProps.md)
|
||||
|
||||
↳ **`AdminGetPriceListPaginationParams`**
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[created_at](internal-13.FilterablePriceListProps.md#created_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:19
|
||||
|
||||
___
|
||||
|
||||
### customer\_groups
|
||||
|
||||
• `Optional` **customer\_groups**: `string`[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[customer_groups](internal-13.FilterablePriceListProps.md#customer_groups)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:16
|
||||
|
||||
___
|
||||
|
||||
### deleted\_at
|
||||
|
||||
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[deleted_at](internal-13.FilterablePriceListProps.md#deleted_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• `Optional` **description**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[description](internal-13.FilterablePriceListProps.md#description)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### expand
|
||||
|
||||
• `Optional` **expand**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:37
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• `Optional` **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[id](internal-13.FilterablePriceListProps.md#id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### limit
|
||||
|
||||
• `Optional` **limit**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:36
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• `Optional` **name**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[name](internal-13.FilterablePriceListProps.md#name)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### offset
|
||||
|
||||
• `Optional` **offset**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:35
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• `Optional` **order**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:38
|
||||
|
||||
___
|
||||
|
||||
### q
|
||||
|
||||
• `Optional` **q**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[q](internal-13.FilterablePriceListProps.md#q)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md)[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[status](internal-13.FilterablePriceListProps.md#status)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md)[]
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[type](internal-13.FilterablePriceListProps.md#type)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:18
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[FilterablePriceListProps](internal-13.FilterablePriceListProps.md).[updated_at](internal-13.FilterablePriceListProps.md#updated_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/price-list.d.ts:20
|
||||
@@ -0,0 +1,205 @@
|
||||
# Class: AdminGetPriceListsPriceListProductsParams
|
||||
|
||||
[internal](../modules/internal-13.md).AdminGetPriceListsPriceListProductsParams
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-13.md#admingetpricelistspricelistproductsparams_base)
|
||||
|
||||
↳ **`AdminGetPriceListsPriceListProductsParams`**
|
||||
|
||||
## Properties
|
||||
|
||||
### collection\_id
|
||||
|
||||
• `Optional` **collection\_id**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:59
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:67
|
||||
|
||||
___
|
||||
|
||||
### deleted\_at
|
||||
|
||||
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:69
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• `Optional` **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:62
|
||||
|
||||
___
|
||||
|
||||
### expand
|
||||
|
||||
• `Optional` **expand**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
AdminGetPriceListsPriceListProductsParams\_base.expand
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:116
|
||||
|
||||
___
|
||||
|
||||
### fields
|
||||
|
||||
• `Optional` **fields**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
AdminGetPriceListsPriceListProductsParams\_base.fields
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:117
|
||||
|
||||
___
|
||||
|
||||
### handle
|
||||
|
||||
• `Optional` **handle**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:63
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• `Optional` **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:56
|
||||
|
||||
___
|
||||
|
||||
### is\_giftcard
|
||||
|
||||
• `Optional` **is\_giftcard**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:64
|
||||
|
||||
___
|
||||
|
||||
### limit
|
||||
|
||||
• `Optional` **limit**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
AdminGetPriceListsPriceListProductsParams\_base.limit
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:121
|
||||
|
||||
___
|
||||
|
||||
### offset
|
||||
|
||||
• `Optional` **offset**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
AdminGetPriceListsPriceListProductsParams\_base.offset
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:120
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• `Optional` **order**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:66
|
||||
|
||||
___
|
||||
|
||||
### q
|
||||
|
||||
• `Optional` **q**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:57
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:58
|
||||
|
||||
___
|
||||
|
||||
### tags
|
||||
|
||||
• `Optional` **tags**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:60
|
||||
|
||||
___
|
||||
|
||||
### title
|
||||
|
||||
• `Optional` **title**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:61
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• `Optional` **type**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:65
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:68
|
||||
@@ -0,0 +1,23 @@
|
||||
# Class: AdminPostPriceListPricesPricesReq
|
||||
|
||||
[internal](../modules/internal-13.md).AdminPostPriceListPricesPricesReq
|
||||
|
||||
## Properties
|
||||
|
||||
### override
|
||||
|
||||
• `Optional` **override**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:69
|
||||
|
||||
___
|
||||
|
||||
### prices
|
||||
|
||||
• **prices**: [`AdminPriceListPricesUpdateReq`](internal-13.AdminPriceListPricesUpdateReq.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:68
|
||||
@@ -0,0 +1,83 @@
|
||||
# Class: AdminPostPriceListsPriceListPriceListReq
|
||||
|
||||
[internal](../modules/internal-13.md).AdminPostPriceListsPriceListPriceListReq
|
||||
|
||||
## Properties
|
||||
|
||||
### customer\_groups
|
||||
|
||||
• `Optional` **customer\_groups**: [`CustomerGroup`](internal-13.CustomerGroup-1.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:91
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• `Optional` **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:85
|
||||
|
||||
___
|
||||
|
||||
### ends\_at
|
||||
|
||||
• `Optional` **ends\_at**: ``null`` \| `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• `Optional` **name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### prices
|
||||
|
||||
• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-13.AdminPriceListPricesUpdateReq.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:90
|
||||
|
||||
___
|
||||
|
||||
### starts\_at
|
||||
|
||||
• `Optional` **starts\_at**: ``null`` \| `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:88
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:89
|
||||
@@ -0,0 +1,83 @@
|
||||
# Class: AdminPostPriceListsPriceListReq
|
||||
|
||||
[internal](../modules/internal-13.md).AdminPostPriceListsPriceListReq
|
||||
|
||||
## Properties
|
||||
|
||||
### customer\_groups
|
||||
|
||||
• `Optional` **customer\_groups**: [`CustomerGroup`](internal-13.CustomerGroup.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:87
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:81
|
||||
|
||||
___
|
||||
|
||||
### ends\_at
|
||||
|
||||
• `Optional` **ends\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:83
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:80
|
||||
|
||||
___
|
||||
|
||||
### prices
|
||||
|
||||
• **prices**: [`AdminPriceListPricesCreateReq`](internal-13.AdminPriceListPricesCreateReq.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:86
|
||||
|
||||
___
|
||||
|
||||
### starts\_at
|
||||
|
||||
• `Optional` **starts\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:82
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:84
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`PriceListType`](../enums/internal.PriceListType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:85
|
||||
@@ -1,10 +1,6 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminPriceListPricesCreateReq
|
||||
|
||||
[internal](../modules/internal.md).AdminPriceListPricesCreateReq
|
||||
[internal](../modules/internal-13.md).AdminPriceListPricesCreateReq
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:35
|
||||
medusa/dist/types/price-list.d.ts:35
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +20,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:34
|
||||
medusa/dist/types/price-list.d.ts:34
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +30,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:38
|
||||
medusa/dist/types/price-list.d.ts:38
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +40,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:37
|
||||
medusa/dist/types/price-list.d.ts:37
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +50,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:33
|
||||
medusa/dist/types/price-list.d.ts:33
|
||||
|
||||
___
|
||||
|
||||
@@ -64,4 +60,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:36
|
||||
medusa/dist/types/price-list.d.ts:36
|
||||
@@ -1,10 +1,6 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminPriceListPricesUpdateReq
|
||||
|
||||
[internal](../modules/internal.md).AdminPriceListPricesUpdateReq
|
||||
[internal](../modules/internal-13.md).AdminPriceListPricesUpdateReq
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:28
|
||||
medusa/dist/types/price-list.d.ts:28
|
||||
|
||||
___
|
||||
|
||||
@@ -24,7 +20,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:26
|
||||
medusa/dist/types/price-list.d.ts:26
|
||||
|
||||
___
|
||||
|
||||
@@ -34,7 +30,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:24
|
||||
medusa/dist/types/price-list.d.ts:24
|
||||
|
||||
___
|
||||
|
||||
@@ -44,7 +40,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:30
|
||||
medusa/dist/types/price-list.d.ts:30
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +50,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:29
|
||||
medusa/dist/types/price-list.d.ts:29
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +60,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:25
|
||||
medusa/dist/types/price-list.d.ts:25
|
||||
|
||||
___
|
||||
|
||||
@@ -74,4 +70,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:27
|
||||
medusa/dist/types/price-list.d.ts:27
|
||||
@@ -0,0 +1,13 @@
|
||||
# Class: CustomerGroup
|
||||
|
||||
[internal](../modules/internal-13.md).CustomerGroup
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:81
|
||||
@@ -0,0 +1,13 @@
|
||||
# Class: CustomerGroup
|
||||
|
||||
[internal](../modules/internal-13.md).CustomerGroup
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:77
|
||||
@@ -1,26 +1,22 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: FilterablePriceListProps
|
||||
|
||||
[internal](../modules/internal.md).FilterablePriceListProps
|
||||
[internal](../modules/internal-13.md).FilterablePriceListProps
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- **`FilterablePriceListProps`**
|
||||
|
||||
↳ [`AdminGetPriceListPaginationParams`](internal.AdminGetPriceListPaginationParams.md)
|
||||
↳ [`AdminGetPriceListPaginationParams`](internal-13.AdminGetPriceListPaginationParams.md)
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:19
|
||||
medusa/dist/types/price-list.d.ts:19
|
||||
|
||||
___
|
||||
|
||||
@@ -30,17 +26,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:16
|
||||
medusa/dist/types/price-list.d.ts:16
|
||||
|
||||
___
|
||||
|
||||
### deleted\_at
|
||||
|
||||
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:21
|
||||
medusa/dist/types/price-list.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
@@ -50,7 +46,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:17
|
||||
medusa/dist/types/price-list.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
@@ -60,7 +56,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:12
|
||||
medusa/dist/types/price-list.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
@@ -70,7 +66,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:15
|
||||
medusa/dist/types/price-list.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
@@ -80,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:13
|
||||
medusa/dist/types/price-list.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
@@ -90,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:14
|
||||
medusa/dist/types/price-list.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
@@ -100,14 +96,14 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:18
|
||||
medusa/dist/types/price-list.d.ts:18
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
|
||||
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:20
|
||||
medusa/dist/types/price-list.d.ts:20
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user