diff --git a/.github/workflows/generate-js-reference.yml b/.github/workflows/generate-js-reference.yml new file mode 100644 index 0000000000..e3d626d2a2 --- /dev/null +++ b/.github/workflows/generate-js-reference.yml @@ -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/** diff --git a/.github/workflows/generate-reference.yml b/.github/workflows/generate-reference.yml index 0a2a100458..629dc50173 100644 --- a/.github/workflows/generate-reference.yml +++ b/.github/workflows/generate-reference.yml @@ -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 - with: - commit_message: "docs: automatically Generated Services Reference" - file_pattern: docs/content/* - skip_dirty_check: false - branch: master + - name: Create Pull Request + uses: peter-evans/create-pull-request@v4 + with: + commit-message: 'docs: Generated Services Reference (automated)' + base: 'master' + title: 'docs: Generated Services Reference (automated)' + labels: 'type: docs' + add-paths: docs/content/references/services/** diff --git a/docs/content/references/js-client/classes/AddressesResource.md b/docs/content/references/js-client/classes/AddressesResource.md index 8c0729a5f0..233d64a507 100644 --- a/docs/content/references/js-client/classes/AddressesResource.md +++ b/docs/content/references/js-client/classes/AddressesResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/Admin.md b/docs/content/references/js-client/classes/Admin.md index 6025323054..2cc36e5896 100644 --- a/docs/content/references/js-client/classes/Admin.md +++ b/docs/content/references/js-client/classes/Admin.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminAuthResource.md b/docs/content/references/js-client/classes/AdminAuthResource.md index f9ce872d27..9d96917f69 100644 --- a/docs/content/references/js-client/classes/AdminAuthResource.md +++ b/docs/content/references/js-client/classes/AdminAuthResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminBatchJobsResource.md b/docs/content/references/js-client/classes/AdminBatchJobsResource.md new file mode 100644 index 0000000000..d8a73f647c --- /dev/null +++ b/docs/content/references/js-client/classes/AdminBatchJobsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminCollectionsResource.md b/docs/content/references/js-client/classes/AdminCollectionsResource.md index 3b271dcab7..53880ee54a 100644 --- a/docs/content/references/js-client/classes/AdminCollectionsResource.md +++ b/docs/content/references/js-client/classes/AdminCollectionsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md b/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md index c0c8fa1d78..b7cd0a01bd 100644 --- a/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md +++ b/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminCustomersResource.md b/docs/content/references/js-client/classes/AdminCustomersResource.md index dae02c6c83..ef773baf1f 100644 --- a/docs/content/references/js-client/classes/AdminCustomersResource.md +++ b/docs/content/references/js-client/classes/AdminCustomersResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminDiscountsResource.md b/docs/content/references/js-client/classes/AdminDiscountsResource.md index 48363a13a2..6bf81888c2 100644 --- a/docs/content/references/js-client/classes/AdminDiscountsResource.md +++ b/docs/content/references/js-client/classes/AdminDiscountsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminDraftOrdersResource.md b/docs/content/references/js-client/classes/AdminDraftOrdersResource.md index e2ad2b50a1..61538e7104 100644 --- a/docs/content/references/js-client/classes/AdminDraftOrdersResource.md +++ b/docs/content/references/js-client/classes/AdminDraftOrdersResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminGiftCardsResource.md b/docs/content/references/js-client/classes/AdminGiftCardsResource.md index 43c8987f81..41b9794b38 100644 --- a/docs/content/references/js-client/classes/AdminGiftCardsResource.md +++ b/docs/content/references/js-client/classes/AdminGiftCardsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminInvitesResource.md b/docs/content/references/js-client/classes/AdminInvitesResource.md index 9384c0071c..7e69b80b99 100644 --- a/docs/content/references/js-client/classes/AdminInvitesResource.md +++ b/docs/content/references/js-client/classes/AdminInvitesResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminNotesResource.md b/docs/content/references/js-client/classes/AdminNotesResource.md index 9a5132a05f..042893dc46 100644 --- a/docs/content/references/js-client/classes/AdminNotesResource.md +++ b/docs/content/references/js-client/classes/AdminNotesResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminNotificationsResource.md b/docs/content/references/js-client/classes/AdminNotificationsResource.md index 020355d40a..f44fdc513c 100644 --- a/docs/content/references/js-client/classes/AdminNotificationsResource.md +++ b/docs/content/references/js-client/classes/AdminNotificationsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminOrdersResource.md b/docs/content/references/js-client/classes/AdminOrdersResource.md index b6129b0c8e..59d0f7667f 100644 --- a/docs/content/references/js-client/classes/AdminOrdersResource.md +++ b/docs/content/references/js-client/classes/AdminOrdersResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminPriceListResource.md b/docs/content/references/js-client/classes/AdminPriceListResource.md index 3b0c7db9a0..92e2c9f54b 100644 --- a/docs/content/references/js-client/classes/AdminPriceListResource.md +++ b/docs/content/references/js-client/classes/AdminPriceListResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminProductTagsResource.md b/docs/content/references/js-client/classes/AdminProductTagsResource.md index bb231ef67d..58680c3cb0 100644 --- a/docs/content/references/js-client/classes/AdminProductTagsResource.md +++ b/docs/content/references/js-client/classes/AdminProductTagsResource.md @@ -10,18 +10,18 @@ ### list -▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal.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) diff --git a/docs/content/references/js-client/classes/AdminProductTypesResource.md b/docs/content/references/js-client/classes/AdminProductTypesResource.md index 23fcf6eb80..dc97294ea6 100644 --- a/docs/content/references/js-client/classes/AdminProductTypesResource.md +++ b/docs/content/references/js-client/classes/AdminProductTypesResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminProductsResource.md b/docs/content/references/js-client/classes/AdminProductsResource.md index c97f9392f4..48934b9a0b 100644 --- a/docs/content/references/js-client/classes/AdminProductsResource.md +++ b/docs/content/references/js-client/classes/AdminProductsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminRegionsResource.md b/docs/content/references/js-client/classes/AdminRegionsResource.md index 62f08eb376..b42d703044 100644 --- a/docs/content/references/js-client/classes/AdminRegionsResource.md +++ b/docs/content/references/js-client/classes/AdminRegionsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminReturnReasonsResource.md b/docs/content/references/js-client/classes/AdminReturnReasonsResource.md index 8b6cd82769..a45135a510 100644 --- a/docs/content/references/js-client/classes/AdminReturnReasonsResource.md +++ b/docs/content/references/js-client/classes/AdminReturnReasonsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminReturnsResource.md b/docs/content/references/js-client/classes/AdminReturnsResource.md index 71484b42e2..0454817c31 100644 --- a/docs/content/references/js-client/classes/AdminReturnsResource.md +++ b/docs/content/references/js-client/classes/AdminReturnsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminSalesChannelsResource.md b/docs/content/references/js-client/classes/AdminSalesChannelsResource.md new file mode 100644 index 0000000000..c77d515a7c --- /dev/null +++ b/docs/content/references/js-client/classes/AdminSalesChannelsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminShippingOptionsResource.md b/docs/content/references/js-client/classes/AdminShippingOptionsResource.md index d27a1c48d6..ebf72da47a 100644 --- a/docs/content/references/js-client/classes/AdminShippingOptionsResource.md +++ b/docs/content/references/js-client/classes/AdminShippingOptionsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminShippingProfilesResource.md b/docs/content/references/js-client/classes/AdminShippingProfilesResource.md index 0584ee03a4..427505b028 100644 --- a/docs/content/references/js-client/classes/AdminShippingProfilesResource.md +++ b/docs/content/references/js-client/classes/AdminShippingProfilesResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminStoresResource.md b/docs/content/references/js-client/classes/AdminStoresResource.md index 67ae5411d5..0a78571142 100644 --- a/docs/content/references/js-client/classes/AdminStoresResource.md +++ b/docs/content/references/js-client/classes/AdminStoresResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminSwapsResource.md b/docs/content/references/js-client/classes/AdminSwapsResource.md index 2caac196ee..8d32d69f08 100644 --- a/docs/content/references/js-client/classes/AdminSwapsResource.md +++ b/docs/content/references/js-client/classes/AdminSwapsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminTaxRatesResource.md b/docs/content/references/js-client/classes/AdminTaxRatesResource.md index 67006464b1..dd8b13b235 100644 --- a/docs/content/references/js-client/classes/AdminTaxRatesResource.md +++ b/docs/content/references/js-client/classes/AdminTaxRatesResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminUploadsResource.md b/docs/content/references/js-client/classes/AdminUploadsResource.md index 8336f064f8..c0980263a5 100644 --- a/docs/content/references/js-client/classes/AdminUploadsResource.md +++ b/docs/content/references/js-client/classes/AdminUploadsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminUsersResource.md b/docs/content/references/js-client/classes/AdminUsersResource.md index 4e6417f96b..9f62f6f7f4 100644 --- a/docs/content/references/js-client/classes/AdminUsersResource.md +++ b/docs/content/references/js-client/classes/AdminUsersResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/AdminVariantsResource.md b/docs/content/references/js-client/classes/AdminVariantsResource.md index 1b984352f3..0d3bbfa909 100644 --- a/docs/content/references/js-client/classes/AdminVariantsResource.md +++ b/docs/content/references/js-client/classes/AdminVariantsResource.md @@ -10,19 +10,19 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal.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) diff --git a/docs/content/references/js-client/classes/AuthResource.md b/docs/content/references/js-client/classes/AuthResource.md index ed3796bbb0..7e25f88036 100644 --- a/docs/content/references/js-client/classes/AuthResource.md +++ b/docs/content/references/js-client/classes/AuthResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/CartsResource.md b/docs/content/references/js-client/classes/CartsResource.md index 06ec840888..97606a7c81 100644 --- a/docs/content/references/js-client/classes/CartsResource.md +++ b/docs/content/references/js-client/classes/CartsResource.md @@ -14,13 +14,13 @@ #### Defined in -[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) diff --git a/docs/content/references/js-client/classes/CollectionsResource.md b/docs/content/references/js-client/classes/CollectionsResource.md index 1353946dc6..14b2b8a959 100644 --- a/docs/content/references/js-client/classes/CollectionsResource.md +++ b/docs/content/references/js-client/classes/CollectionsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/CustomerResource.md b/docs/content/references/js-client/classes/CustomerResource.md index 16a0fdd53b..c778ad0280 100644 --- a/docs/content/references/js-client/classes/CustomerResource.md +++ b/docs/content/references/js-client/classes/CustomerResource.md @@ -14,7 +14,7 @@ #### Defined in -[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) diff --git a/docs/content/references/js-client/classes/GiftCardsResource.md b/docs/content/references/js-client/classes/GiftCardsResource.md index d141db3fcc..0b26be9d08 100644 --- a/docs/content/references/js-client/classes/GiftCardsResource.md +++ b/docs/content/references/js-client/classes/GiftCardsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/LineItemsResource.md b/docs/content/references/js-client/classes/LineItemsResource.md index 4a4f7ba2fb..b5bcf194cb 100644 --- a/docs/content/references/js-client/classes/LineItemsResource.md +++ b/docs/content/references/js-client/classes/LineItemsResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.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) diff --git a/docs/content/references/js-client/classes/OrdersResource.md b/docs/content/references/js-client/classes/OrdersResource.md index 94280f681c..9285bd5ce0 100644 --- a/docs/content/references/js-client/classes/OrdersResource.md +++ b/docs/content/references/js-client/classes/OrdersResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/PaymentMethodsResource.md b/docs/content/references/js-client/classes/PaymentMethodsResource.md index 2cc919afd0..408a3558ff 100644 --- a/docs/content/references/js-client/classes/PaymentMethodsResource.md +++ b/docs/content/references/js-client/classes/PaymentMethodsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/ProductVariantsResource.md b/docs/content/references/js-client/classes/ProductVariantsResource.md index a82e7eb9fe..d157398b0d 100644 --- a/docs/content/references/js-client/classes/ProductVariantsResource.md +++ b/docs/content/references/js-client/classes/ProductVariantsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/ProductsResource.md b/docs/content/references/js-client/classes/ProductsResource.md index 011c64d96a..098aafa89a 100644 --- a/docs/content/references/js-client/classes/ProductsResource.md +++ b/docs/content/references/js-client/classes/ProductsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/RegionsResource.md b/docs/content/references/js-client/classes/RegionsResource.md index 1b8624da6b..68dbbd9446 100644 --- a/docs/content/references/js-client/classes/RegionsResource.md +++ b/docs/content/references/js-client/classes/RegionsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/ReturnReasonsResource.md b/docs/content/references/js-client/classes/ReturnReasonsResource.md index 91d0f069d9..3b0d312206 100644 --- a/docs/content/references/js-client/classes/ReturnReasonsResource.md +++ b/docs/content/references/js-client/classes/ReturnReasonsResource.md @@ -10,7 +10,7 @@ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal.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) diff --git a/docs/content/references/js-client/classes/ReturnsResource.md b/docs/content/references/js-client/classes/ReturnsResource.md index d2c3d47810..1a637e193e 100644 --- a/docs/content/references/js-client/classes/ReturnsResource.md +++ b/docs/content/references/js-client/classes/ReturnsResource.md @@ -10,7 +10,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal.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) diff --git a/docs/content/references/js-client/classes/ShippingOptionsResource.md b/docs/content/references/js-client/classes/ShippingOptionsResource.md index 85fde9a45c..7b2304e207 100644 --- a/docs/content/references/js-client/classes/ShippingOptionsResource.md +++ b/docs/content/references/js-client/classes/ShippingOptionsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/SwapsResource.md b/docs/content/references/js-client/classes/SwapsResource.md index 0391fd574a..4ef7f51520 100644 --- a/docs/content/references/js-client/classes/SwapsResource.md +++ b/docs/content/references/js-client/classes/SwapsResource.md @@ -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) diff --git a/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md b/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md new file mode 100644 index 0000000000..d8fb179f42 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.User.md b/docs/content/references/js-client/classes/internal-1.User.md similarity index 57% rename from docs/content/references/js-client/classes/internal.User.md rename to docs/content/references/js-client/classes/internal-1.User.md index 3f4add48b3..3762203aca 100644 --- a/docs/content/references/js-client/classes/internal.User.md +++ b/docs/content/references/js-client/classes/internal-1.User.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-10.AdminGetNotesParams.md b/docs/content/references/js-client/classes/internal-10.AdminGetNotesParams.md new file mode 100644 index 0000000000..f1b4d398d1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-10.AdminGetNotesParams.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-10.AdminPostNotesNoteReq.md b/docs/content/references/js-client/classes/internal-10.AdminPostNotesNoteReq.md new file mode 100644 index 0000000000..a1eca1d459 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-10.AdminPostNotesNoteReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-10.AdminPostNotesReq.md b/docs/content/references/js-client/classes/internal-10.AdminPostNotesReq.md new file mode 100644 index 0000000000..42136a04ec --- /dev/null +++ b/docs/content/references/js-client/classes/internal-10.AdminPostNotesReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.Note.md b/docs/content/references/js-client/classes/internal-10.Note.md similarity index 57% rename from docs/content/references/js-client/classes/internal.Note.md rename to docs/content/references/js-client/classes/internal-10.Note.md index df76c91f4d..5788acab18 100644 --- a/docs/content/references/js-client/classes/internal.Note.md +++ b/docs/content/references/js-client/classes/internal-10.Note.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-11.AdminGetNotificationsParams.md b/docs/content/references/js-client/classes/internal-11.AdminGetNotificationsParams.md new file mode 100644 index 0000000000..dd8105efac --- /dev/null +++ b/docs/content/references/js-client/classes/internal-11.AdminGetNotificationsParams.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-11.AdminPostNotificationsNotificationResendReq.md b/docs/content/references/js-client/classes/internal-11.AdminPostNotificationsNotificationResendReq.md new file mode 100644 index 0000000000..2c83b04896 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-11.AdminPostNotificationsNotificationResendReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.Notification.md b/docs/content/references/js-client/classes/internal-11.Notification.md similarity index 50% rename from docs/content/references/js-client/classes/internal.Notification.md rename to docs/content/references/js-client/classes/internal-11.Notification.md index b64252e1e1..f138b548db 100644 --- a/docs/content/references/js-client/classes/internal.Notification.md +++ b/docs/content/references/js-client/classes/internal-11.Notification.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-11.NotificationProvider.md b/docs/content/references/js-client/classes/internal-11.NotificationProvider.md new file mode 100644 index 0000000000..103352d80b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-11.NotificationProvider.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdditionalItem-1.md b/docs/content/references/js-client/classes/internal-12.AdditionalItem-1.md new file mode 100644 index 0000000000..977e91fb90 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdditionalItem-1.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdditionalItem.md b/docs/content/references/js-client/classes/internal-12.AdditionalItem.md new file mode 100644 index 0000000000..84360a75da --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdditionalItem.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminGetOrdersParams.md b/docs/content/references/js-client/classes/internal-12.AdminGetOrdersParams.md new file mode 100644 index 0000000000..807c7a36b5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminGetOrdersParams.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.AdminListOrdersSelector.md b/docs/content/references/js-client/classes/internal-12.AdminListOrdersSelector.md similarity index 58% rename from docs/content/references/js-client/classes/internal.AdminListOrdersSelector.md rename to docs/content/references/js-client/classes/internal-12.AdminListOrdersSelector.md index a3c582aebd..b7851a4dc7 100644 --- a/docs/content/references/js-client/classes/internal.AdminListOrdersSelector.md +++ b/docs/content/references/js-client/classes/internal-12.AdminListOrdersSelector.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md new file mode 100644 index 0000000000..ee5f0f569d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md new file mode 100644 index 0000000000..91cbeb7135 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md new file mode 100644 index 0000000000..cd5033d8b9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsReq.md new file mode 100644 index 0000000000..39a9641b32 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderClaimsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md new file mode 100644 index 0000000000..19e4352eb2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderRefundsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderRefundsReq.md new file mode 100644 index 0000000000..dedfc2ed96 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderRefundsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReq.md new file mode 100644 index 0000000000..91ad5c651e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReturnsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReturnsReq.md new file mode 100644 index 0000000000..4765f7a724 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderReturnsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShipmentReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShipmentReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShipmentReq.md rename to docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShipmentReq.md index 70432f856d..c7830193ad 100644 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShipmentReq.md +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShipmentReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md new file mode 100644 index 0000000000..7f86d4bbcc --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsReq.md new file mode 100644 index 0000000000..39a7c6c038 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md new file mode 100644 index 0000000000..4d4c5a2e49 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md new file mode 100644 index 0000000000..b5a76b9cd1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.CustomShippingOption.md b/docs/content/references/js-client/classes/internal-12.CustomShippingOption.md new file mode 100644 index 0000000000..8db78a6b22 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.CustomShippingOption.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.Image.md b/docs/content/references/js-client/classes/internal-12.Image.md new file mode 100644 index 0000000000..82219ee79a --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.Image.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.Item-1.md b/docs/content/references/js-client/classes/internal-12.Item-1.md new file mode 100644 index 0000000000..c23f306e6b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.Item-1.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.Item-2.md b/docs/content/references/js-client/classes/internal-12.Item-2.md new file mode 100644 index 0000000000..4818e09735 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.Item-2.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.Item.md b/docs/content/references/js-client/classes/internal-12.Item.md new file mode 100644 index 0000000000..224f5921a3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.Item.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.OrdersReturnItem.md b/docs/content/references/js-client/classes/internal-12.OrdersReturnItem.md similarity index 54% rename from docs/content/references/js-client/classes/internal.OrdersReturnItem.md rename to docs/content/references/js-client/classes/internal-12.OrdersReturnItem.md index f6b8bc77a4..81ed6aed43 100644 --- a/docs/content/references/js-client/classes/internal.OrdersReturnItem.md +++ b/docs/content/references/js-client/classes/internal-12.OrdersReturnItem.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.PaymentMethod.md b/docs/content/references/js-client/classes/internal-12.PaymentMethod.md new file mode 100644 index 0000000000..3e7190a35e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.PaymentMethod.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.ReturnItem.md b/docs/content/references/js-client/classes/internal-12.ReturnItem.md new file mode 100644 index 0000000000..65219936f2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.ReturnItem.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.ReturnShipping-1.md b/docs/content/references/js-client/classes/internal-12.ReturnShipping-1.md new file mode 100644 index 0000000000..c00db5f816 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.ReturnShipping-1.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.ReturnShipping-2.md b/docs/content/references/js-client/classes/internal-12.ReturnShipping-2.md new file mode 100644 index 0000000000..232a5badbb --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.ReturnShipping-2.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.ReturnShipping.md b/docs/content/references/js-client/classes/internal-12.ReturnShipping.md new file mode 100644 index 0000000000..cf9a3a7171 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.ReturnShipping.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.ShippingMethod-1.md b/docs/content/references/js-client/classes/internal-12.ShippingMethod-1.md new file mode 100644 index 0000000000..b66e2b8520 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.ShippingMethod-1.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.ShippingMethod-2.md b/docs/content/references/js-client/classes/internal-12.ShippingMethod-2.md new file mode 100644 index 0000000000..f6850708cb --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.ShippingMethod-2.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.ShippingMethod.md b/docs/content/references/js-client/classes/internal-12.ShippingMethod.md new file mode 100644 index 0000000000..c95445f3b8 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.ShippingMethod.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-12.Tag.md b/docs/content/references/js-client/classes/internal-12.Tag.md new file mode 100644 index 0000000000..ad628244b0 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-12.Tag.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-13.AdminDeletePriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal-13.AdminDeletePriceListPricesPricesReq.md new file mode 100644 index 0000000000..1554534380 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminDeletePriceListPricesPricesReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-13.AdminGetPriceListPaginationParams.md b/docs/content/references/js-client/classes/internal-13.AdminGetPriceListPaginationParams.md new file mode 100644 index 0000000000..21a1a2e94f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminGetPriceListPaginationParams.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-13.AdminGetPriceListsPriceListProductsParams.md b/docs/content/references/js-client/classes/internal-13.AdminGetPriceListsPriceListProductsParams.md new file mode 100644 index 0000000000..c4044ad91e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminGetPriceListsPriceListProductsParams.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal-13.AdminPostPriceListPricesPricesReq.md new file mode 100644 index 0000000000..dcf50fd2da --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminPostPriceListPricesPricesReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md b/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md new file mode 100644 index 0000000000..2fff640a88 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListReq.md b/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListReq.md new file mode 100644 index 0000000000..830fc05e64 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.AdminPostPriceListsPriceListReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.AdminPriceListPricesCreateReq.md b/docs/content/references/js-client/classes/internal-13.AdminPriceListPricesCreateReq.md similarity index 57% rename from docs/content/references/js-client/classes/internal.AdminPriceListPricesCreateReq.md rename to docs/content/references/js-client/classes/internal-13.AdminPriceListPricesCreateReq.md index 085f1d7f1a..beea806bec 100644 --- a/docs/content/references/js-client/classes/internal.AdminPriceListPricesCreateReq.md +++ b/docs/content/references/js-client/classes/internal-13.AdminPriceListPricesCreateReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.AdminPriceListPricesUpdateReq.md b/docs/content/references/js-client/classes/internal-13.AdminPriceListPricesUpdateReq.md similarity index 57% rename from docs/content/references/js-client/classes/internal.AdminPriceListPricesUpdateReq.md rename to docs/content/references/js-client/classes/internal-13.AdminPriceListPricesUpdateReq.md index 15ac9af22a..355969312e 100644 --- a/docs/content/references/js-client/classes/internal.AdminPriceListPricesUpdateReq.md +++ b/docs/content/references/js-client/classes/internal-13.AdminPriceListPricesUpdateReq.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-13.CustomerGroup-1.md b/docs/content/references/js-client/classes/internal-13.CustomerGroup-1.md new file mode 100644 index 0000000000..3cea7efcbd --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.CustomerGroup-1.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-13.CustomerGroup.md b/docs/content/references/js-client/classes/internal-13.CustomerGroup.md new file mode 100644 index 0000000000..5b87175522 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-13.CustomerGroup.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal.FilterablePriceListProps.md b/docs/content/references/js-client/classes/internal-13.FilterablePriceListProps.md similarity index 57% rename from docs/content/references/js-client/classes/internal.FilterablePriceListProps.md rename to docs/content/references/js-client/classes/internal-13.FilterablePriceListProps.md index 647cc83932..e0ff5016ed 100644 --- a/docs/content/references/js-client/classes/internal.FilterablePriceListProps.md +++ b/docs/content/references/js-client/classes/internal-13.FilterablePriceListProps.md @@ -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 diff --git a/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsPaginationParams.md b/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsPaginationParams.md new file mode 100644 index 0000000000..11af7ee073 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsPaginationParams.md @@ -0,0 +1,29 @@ +# Class: AdminGetProductTagsPaginationParams + +[internal](../modules/internal-14.md).AdminGetProductTagsPaginationParams + +## Hierarchy + +- **`AdminGetProductTagsPaginationParams`** + + ↳ [`AdminGetProductTagsParams`](internal-14.AdminGetProductTagsParams.md) + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:30 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsParams.md b/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsParams.md new file mode 100644 index 0000000000..491bf1098b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-14.AdminGetProductTagsParams.md @@ -0,0 +1,97 @@ +# Class: AdminGetProductTagsParams + +[internal](../modules/internal-14.md).AdminGetProductTagsParams + +## Hierarchy + +- [`AdminGetProductTagsPaginationParams`](internal-14.AdminGetProductTagsPaginationParams.md) + + ↳ **`AdminGetProductTagsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:37 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:34 + +___ + +### limit + +• **limit**: `number` + +#### Inherited from + +[AdminGetProductTagsPaginationParams](internal-14.AdminGetProductTagsPaginationParams.md).[limit](internal-14.AdminGetProductTagsPaginationParams.md#limit) + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:30 + +___ + +### offset + +• **offset**: `number` + +#### Inherited from + +[AdminGetProductTagsPaginationParams](internal-14.AdminGetProductTagsPaginationParams.md).[offset](internal-14.AdminGetProductTagsPaginationParams.md#offset) + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:31 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:39 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:35 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:38 + +___ + +### value + +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesPaginationParams.md b/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesPaginationParams.md new file mode 100644 index 0000000000..1d2b092838 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesPaginationParams.md @@ -0,0 +1,29 @@ +# Class: AdminGetProductTypesPaginationParams + +[internal](../modules/internal-15.md).AdminGetProductTypesPaginationParams + +## Hierarchy + +- **`AdminGetProductTypesPaginationParams`** + + ↳ [`AdminGetProductTypesParams`](internal-15.AdminGetProductTypesParams.md) + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:30 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesParams.md b/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesParams.md new file mode 100644 index 0000000000..673acf8f67 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-15.AdminGetProductTypesParams.md @@ -0,0 +1,97 @@ +# Class: AdminGetProductTypesParams + +[internal](../modules/internal-15.md).AdminGetProductTypesParams + +## Hierarchy + +- [`AdminGetProductTypesPaginationParams`](internal-15.AdminGetProductTypesPaginationParams.md) + + ↳ **`AdminGetProductTypesParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:37 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:34 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[AdminGetProductTypesPaginationParams](internal-15.AdminGetProductTypesPaginationParams.md).[limit](internal-15.AdminGetProductTypesPaginationParams.md#limit) + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:30 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[AdminGetProductTypesPaginationParams](internal-15.AdminGetProductTypesPaginationParams.md).[offset](internal-15.AdminGetProductTypesPaginationParams.md#offset) + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:31 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:39 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:35 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:38 + +___ + +### value + +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal-16.AdminGetProductsParams.md b/docs/content/references/js-client/classes/internal-16.AdminGetProductsParams.md new file mode 100644 index 0000000000..0ee1f450bf --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminGetProductsParams.md @@ -0,0 +1,261 @@ +# Class: AdminGetProductsParams + +[internal](../modules/internal-16.md).AdminGetProductsParams + +API Level DTOs + Validation rules + +## Hierarchy + +- [`FilterableProductProps`](internal-16.FilterableProductProps.md) + + ↳ **`AdminGetProductsParams`** + +## Properties + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[collection_id](internal-16.FilterableProductProps.md#collection_id) + +#### Defined in + +medusa/dist/types/product.d.ts:12 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[created_at](internal-16.FilterableProductProps.md#created_at) + +#### Defined in + +medusa/dist/types/product.d.ts:20 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[deleted_at](internal-16.FilterableProductProps.md#deleted_at) + +#### Defined in + +medusa/dist/types/product.d.ts:22 + +___ + +### description + +• `Optional` **description**: `string` + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[description](internal-16.FilterableProductProps.md#description) + +#### Defined in + +medusa/dist/types/product.d.ts:15 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/list-products.d.ts:56 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/list-products.d.ts:57 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[handle](internal-16.FilterableProductProps.md#handle) + +#### Defined in + +medusa/dist/types/product.d.ts:16 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[id](internal-16.FilterableProductProps.md#id) + +#### Defined in + +medusa/dist/types/product.d.ts:8 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `boolean` + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[is_giftcard](internal-16.FilterableProductProps.md#is_giftcard) + +#### Defined in + +medusa/dist/types/product.d.ts:17 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/list-products.d.ts:55 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/list-products.d.ts:54 + +___ + +### price\_list\_id + +• `Optional` **price\_list\_id**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[price_list_id](internal-16.FilterableProductProps.md#price_list_id) + +#### Defined in + +medusa/dist/types/product.d.ts:11 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[q](internal-16.FilterableProductProps.md#q) + +#### Defined in + +medusa/dist/types/product.d.ts:9 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[sales_channel_id](internal-16.FilterableProductProps.md#sales_channel_id) + +#### Defined in + +medusa/dist/types/product.d.ts:19 + +___ + +### status + +• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[] + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[status](internal-16.FilterableProductProps.md#status) + +#### Defined in + +medusa/dist/types/product.d.ts:10 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[tags](internal-16.FilterableProductProps.md#tags) + +#### Defined in + +medusa/dist/types/product.d.ts:13 + +___ + +### title + +• `Optional` **title**: `string` + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[title](internal-16.FilterableProductProps.md#title) + +#### Defined in + +medusa/dist/types/product.d.ts:14 + +___ + +### type + +• `Optional` **type**: `string` + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[type](internal-16.FilterableProductProps.md#type) + +#### Defined in + +medusa/dist/types/product.d.ts:18 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableProductProps](internal-16.FilterableProductProps.md).[updated_at](internal-16.FilterableProductProps.md#updated_at) + +#### Defined in + +medusa/dist/types/product.d.ts:21 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductMetadataReq.md b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductMetadataReq.md new file mode 100644 index 0000000000..bcb381322a --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductMetadataReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostProductsProductMetadataReq + +[internal](../modules/internal-16.md).AdminPostProductsProductMetadataReq + +## Properties + +### key + +• **key**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/set-metadata.d.ts:38 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/set-metadata.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsOption.md b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsOption.md new file mode 100644 index 0000000000..64c440e1a4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsOption.md @@ -0,0 +1,13 @@ +# Class: AdminPostProductsProductOptionsOption + +[internal](../modules/internal-16.md).AdminPostProductsProductOptionsOption + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-option.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsReq.md b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsReq.md new file mode 100644 index 0000000000..ed5cf4eca6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductOptionsReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostProductsProductOptionsReq + +[internal](../modules/internal-16.md).AdminPostProductsProductOptionsReq + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/add-option.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductReq.md b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductReq.md new file mode 100644 index 0000000000..2662e67f88 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductReq.md @@ -0,0 +1,223 @@ +# Class: AdminPostProductsProductReq + +[internal](../modules/internal-16.md).AdminPostProductsProductReq + +## Properties + +### collection\_id + +• `Optional` **collection\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:233 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:226 + +___ + +### discountable + +• `Optional` **discountable**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:227 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:230 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:239 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:241 + +___ + +### images + +• **images**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:228 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:238 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:244 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:245 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:243 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:242 + +___ + +### sales\_channels + +• **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-16.ProductSalesChannelReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:235 + +___ + +### status + +• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md) + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:231 + +___ + +### subtitle + +• `Optional` **subtitle**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:225 + +___ + +### tags + +• `Optional` **tags**: [`ProductTagReq`](internal-16.ProductTagReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:234 + +___ + +### thumbnail + +• `Optional` **thumbnail**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:229 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:224 + +___ + +### type + +• `Optional` **type**: [`ProductTypeReq`](internal-16.ProductTypeReq.md) + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:232 + +___ + +### variants + +• `Optional` **variants**: [`ProductVariantReq`](internal-16.ProductVariantReq-1.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:236 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:237 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:240 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsReq.md b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsReq.md new file mode 100644 index 0000000000..c5fe4de087 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsReq.md @@ -0,0 +1,193 @@ +# Class: AdminPostProductsProductVariantsReq + +[internal](../modules/internal-16.md).AdminPostProductsProductVariantsReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:125 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:122 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:120 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:129 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:123 + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:124 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:128 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:126 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:133 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:134 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:132 + +___ + +### options + +• **options**: [`ProductVariantOptionReq`](internal-16.ProductVariantOptionReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:136 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:131 + +___ + +### prices + +• **prices**: [`ProductVariantPricesCreateReq`](internal-16.ProductVariantPricesCreateReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:135 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:119 + +___ + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:118 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:121 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:127 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:130 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsVariantReq.md b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsVariantReq.md new file mode 100644 index 0000000000..15e7fe5f84 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminPostProductsProductVariantsVariantReq.md @@ -0,0 +1,193 @@ +# Class: AdminPostProductsProductVariantsVariantReq + +[internal](../modules/internal-16.md).AdminPostProductsProductVariantsVariantReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:125 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:122 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:120 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:129 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:123 + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:124 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:128 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:126 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:133 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:134 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:132 + +___ + +### options + +• **options**: [`ProductVariantOptionReq`](internal-16.ProductVariantOptionReq-1.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:136 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:131 + +___ + +### prices + +• **prices**: [`ProductVariantPricesUpdateReq`](internal-16.ProductVariantPricesUpdateReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:135 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:119 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:118 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:121 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:127 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:130 diff --git a/docs/content/references/js-client/classes/internal-16.AdminPostProductsReq.md b/docs/content/references/js-client/classes/internal-16.AdminPostProductsReq.md new file mode 100644 index 0000000000..9bcba4169a --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.AdminPostProductsReq.md @@ -0,0 +1,243 @@ +# Class: AdminPostProductsReq + +[internal](../modules/internal-16.md).AdminPostProductsReq + +## Properties + +### collection\_id + +• `Optional` **collection\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:239 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:231 + +___ + +### discountable + +• **discountable**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:233 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:236 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:246 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:248 + +___ + +### images + +• `Optional` **images**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:234 + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:232 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:245 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:251 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:252 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:250 + +___ + +### options + +• `Optional` **options**: [`ProductOptionReq`](internal-16.ProductOptionReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:242 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:249 + +___ + +### sales\_channels + +• `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-16.ProductSalesChannelReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:241 + +___ + +### status + +• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md) + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:237 + +___ + +### subtitle + +• `Optional` **subtitle**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:230 + +___ + +### tags + +• `Optional` **tags**: [`ProductTagReq`](internal-16.ProductTagReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:240 + +___ + +### thumbnail + +• `Optional` **thumbnail**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:235 + +___ + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:229 + +___ + +### type + +• `Optional` **type**: [`ProductTypeReq`](internal-16.ProductTypeReq.md) + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:238 + +___ + +### variants + +• `Optional` **variants**: [`ProductVariantReq`](internal-16.ProductVariantReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:243 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:244 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:247 diff --git a/docs/content/references/js-client/classes/internal-16.FilterableProductProps.md b/docs/content/references/js-client/classes/internal-16.FilterableProductProps.md new file mode 100644 index 0000000000..86520f7aa1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.FilterableProductProps.md @@ -0,0 +1,161 @@ +# Class: FilterableProductProps + +[internal](../modules/internal-16.md).FilterableProductProps + +API Level DTOs + Validation rules + +## Hierarchy + +- **`FilterableProductProps`** + + ↳ [`AdminGetProductsParams`](internal-16.AdminGetProductsParams.md) + +## Properties + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Defined in + +medusa/dist/types/product.d.ts:12 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/types/product.d.ts:20 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/types/product.d.ts:22 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:15 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:16 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +medusa/dist/types/product.d.ts:8 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `boolean` + +#### Defined in + +medusa/dist/types/product.d.ts:17 + +___ + +### price\_list\_id + +• `Optional` **price\_list\_id**: `string`[] + +#### Defined in + +medusa/dist/types/product.d.ts:11 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:9 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string`[] + +#### Defined in + +medusa/dist/types/product.d.ts:19 + +___ + +### status + +• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[] + +#### Defined in + +medusa/dist/types/product.d.ts:10 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Defined in + +medusa/dist/types/product.d.ts:13 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:14 + +___ + +### type + +• `Optional` **type**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:18 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/types/product.d.ts:21 diff --git a/docs/content/references/js-client/classes/internal-16.ProductOptionReq.md b/docs/content/references/js-client/classes/internal-16.ProductOptionReq.md new file mode 100644 index 0000000000..851046ae0a --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductOptionReq.md @@ -0,0 +1,13 @@ +# Class: ProductOptionReq + +[internal](../modules/internal-16.md).ProductOptionReq + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:205 diff --git a/docs/content/references/js-client/classes/internal-16.ProductSalesChannelReq.md b/docs/content/references/js-client/classes/internal-16.ProductSalesChannelReq.md new file mode 100644 index 0000000000..bd352ad42a --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductSalesChannelReq.md @@ -0,0 +1,13 @@ +# Class: ProductSalesChannelReq + +[internal](../modules/internal-16.md).ProductSalesChannelReq + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:146 diff --git a/docs/content/references/js-client/classes/internal-16.ProductTagReq.md b/docs/content/references/js-client/classes/internal-16.ProductTagReq.md new file mode 100644 index 0000000000..0df04ee57d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductTagReq.md @@ -0,0 +1,23 @@ +# Class: ProductTagReq + +[internal](../modules/internal-16.md).ProductTagReq + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:149 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:150 diff --git a/docs/content/references/js-client/classes/internal-16.ProductTypeReq.md b/docs/content/references/js-client/classes/internal-16.ProductTypeReq.md new file mode 100644 index 0000000000..11478f7b4c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductTypeReq.md @@ -0,0 +1,23 @@ +# Class: ProductTypeReq + +[internal](../modules/internal-16.md).ProductTypeReq + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:153 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/types/product.d.ts:154 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-1.md b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-1.md new file mode 100644 index 0000000000..b7e3f3784d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-1.md @@ -0,0 +1,23 @@ +# Class: ProductVariantOptionReq + +[internal](../modules/internal-16.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:115 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-variant.d.ts:114 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-2.md b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-2.md new file mode 100644 index 0000000000..f35470a10b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-2.md @@ -0,0 +1,13 @@ +# Class: ProductVariantOptionReq + +[internal](../modules/internal-16.md).ProductVariantOptionReq + +## Properties + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:202 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-3.md b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-3.md new file mode 100644 index 0000000000..6003aa0b6c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq-3.md @@ -0,0 +1,23 @@ +# Class: ProductVariantOptionReq + +[internal](../modules/internal-16.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:199 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:198 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq.md b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq.md new file mode 100644 index 0000000000..cdf0c74f13 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductVariantOptionReq.md @@ -0,0 +1,23 @@ +# Class: ProductVariantOptionReq + +[internal](../modules/internal-16.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:115 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-variant.d.ts:114 diff --git a/docs/content/references/js-client/classes/internal.ProductVariantPricesCreateReq.md b/docs/content/references/js-client/classes/internal-16.ProductVariantPricesCreateReq.md similarity index 55% rename from docs/content/references/js-client/classes/internal.ProductVariantPricesCreateReq.md rename to docs/content/references/js-client/classes/internal-16.ProductVariantPricesCreateReq.md index c21b827ca0..b4a53e62ab 100644 --- a/docs/content/references/js-client/classes/internal.ProductVariantPricesCreateReq.md +++ b/docs/content/references/js-client/classes/internal-16.ProductVariantPricesCreateReq.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: ProductVariantPricesCreateReq -[internal](../modules/internal.md).ProductVariantPricesCreateReq +[internal](../modules/internal-16.md).ProductVariantPricesCreateReq ## Properties @@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/product-variant.d.ts:99 +medusa/dist/types/product-variant.d.ts:100 ___ @@ -24,7 +20,7 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:98 +medusa/dist/types/product-variant.d.ts:99 ___ @@ -34,7 +30,7 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:101 +medusa/dist/types/product-variant.d.ts:102 ___ @@ -44,7 +40,7 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:100 +medusa/dist/types/product-variant.d.ts:101 ___ @@ -54,4 +50,4 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:97 +medusa/dist/types/product-variant.d.ts:98 diff --git a/docs/content/references/js-client/classes/internal.ProductVariantPricesUpdateReq.md b/docs/content/references/js-client/classes/internal-16.ProductVariantPricesUpdateReq.md similarity index 55% rename from docs/content/references/js-client/classes/internal.ProductVariantPricesUpdateReq.md rename to docs/content/references/js-client/classes/internal-16.ProductVariantPricesUpdateReq.md index e472835463..020637c1e1 100644 --- a/docs/content/references/js-client/classes/internal.ProductVariantPricesUpdateReq.md +++ b/docs/content/references/js-client/classes/internal-16.ProductVariantPricesUpdateReq.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: ProductVariantPricesUpdateReq -[internal](../modules/internal.md).ProductVariantPricesUpdateReq +[internal](../modules/internal-16.md).ProductVariantPricesUpdateReq ## Properties @@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/product-variant.d.ts:92 +medusa/dist/types/product-variant.d.ts:93 ___ @@ -24,7 +20,7 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:91 +medusa/dist/types/product-variant.d.ts:92 ___ @@ -34,7 +30,7 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:89 +medusa/dist/types/product-variant.d.ts:90 ___ @@ -44,7 +40,7 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:94 +medusa/dist/types/product-variant.d.ts:95 ___ @@ -54,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:93 +medusa/dist/types/product-variant.d.ts:94 ___ @@ -64,4 +60,4 @@ ___ #### Defined in -packages/medusa/dist/types/product-variant.d.ts:90 +medusa/dist/types/product-variant.d.ts:91 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantReq-1.md b/docs/content/references/js-client/classes/internal-16.ProductVariantReq-1.md new file mode 100644 index 0000000000..e15137a08b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductVariantReq-1.md @@ -0,0 +1,203 @@ +# Class: ProductVariantReq + +[internal](../modules/internal-16.md).ProductVariantReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:210 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:207 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:205 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:214 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:208 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:202 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:209 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:213 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:211 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:218 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:219 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:217 + +___ + +### options + +• `Optional` **options**: [`ProductVariantOptionReq`](internal-16.ProductVariantOptionReq-3.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:221 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:216 + +___ + +### prices + +• **prices**: [`ProductVariantPricesUpdateReq`](internal-16.ProductVariantPricesUpdateReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:220 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:204 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:203 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:206 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:212 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/update-product.d.ts:215 diff --git a/docs/content/references/js-client/classes/internal-16.ProductVariantReq.md b/docs/content/references/js-client/classes/internal-16.ProductVariantReq.md new file mode 100644 index 0000000000..2e5d271f34 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-16.ProductVariantReq.md @@ -0,0 +1,193 @@ +# Class: ProductVariantReq + +[internal](../modules/internal-16.md).ProductVariantReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:215 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:212 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:210 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:219 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:213 + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:214 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:218 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:216 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:223 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:224 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:222 + +___ + +### options + +• `Optional` **options**: [`ProductVariantOptionReq`](internal-16.ProductVariantOptionReq-2.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:226 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:221 + +___ + +### prices + +• **prices**: [`ProductVariantPricesCreateReq`](internal-16.ProductVariantPricesCreateReq.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:225 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:209 + +___ + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:208 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:211 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:217 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/products/create-product.d.ts:220 diff --git a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsPaginationParams.md b/docs/content/references/js-client/classes/internal-17.AdminGetRegionsPaginationParams.md new file mode 100644 index 0000000000..74b84cc9f2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.AdminGetRegionsPaginationParams.md @@ -0,0 +1,29 @@ +# Class: AdminGetRegionsPaginationParams + +[internal](../modules/internal-17.md).AdminGetRegionsPaginationParams + +## Hierarchy + +- **`AdminGetRegionsPaginationParams`** + + ↳ [`AdminGetRegionsParams`](internal-17.AdminGetRegionsParams.md) + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/regions/list-regions.d.ts:56 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/regions/list-regions.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsParams.md b/docs/content/references/js-client/classes/internal-17.AdminGetRegionsParams.md new file mode 100644 index 0000000000..54714e9d94 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.AdminGetRegionsParams.md @@ -0,0 +1,67 @@ +# Class: AdminGetRegionsParams + +[internal](../modules/internal-17.md).AdminGetRegionsParams + +## Hierarchy + +- [`AdminGetRegionsPaginationParams`](internal-17.AdminGetRegionsPaginationParams.md) + + ↳ **`AdminGetRegionsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/regions/list-regions.d.ts:60 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/regions/list-regions.d.ts:62 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[AdminGetRegionsPaginationParams](internal-17.AdminGetRegionsPaginationParams.md).[limit](internal-17.AdminGetRegionsPaginationParams.md#limit) + +#### Defined in + +medusa/dist/api/routes/admin/regions/list-regions.d.ts:56 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[AdminGetRegionsPaginationParams](internal-17.AdminGetRegionsPaginationParams.md).[offset](internal-17.AdminGetRegionsPaginationParams.md#offset) + +#### Defined in + +medusa/dist/api/routes/admin/regions/list-regions.d.ts:57 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/regions/list-regions.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md b/docs/content/references/js-client/classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md new file mode 100644 index 0000000000..02aa8d51ae --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md @@ -0,0 +1,13 @@ +# Class: AdminGetRegionsRegionFulfillmentOptionsRes + +[internal](../modules/internal-17.md).AdminGetRegionsRegionFulfillmentOptionsRes + +## Properties + +### fulfillment\_options + +• **fulfillment\_options**: [`FulfillmentOption`](internal-17.FulfillmentOption.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/index.d.ts:20 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionCountriesReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionCountriesReq.md new file mode 100644 index 0000000000..911ab6a825 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionCountriesReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostRegionsRegionCountriesReq + +[internal](../modules/internal-17.md).AdminPostRegionsRegionCountriesReq + +## Properties + +### country\_code + +• **country\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/add-country.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md new file mode 100644 index 0000000000..3738199854 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostRegionsRegionFulfillmentProvidersReq + +[internal](../modules/internal-17.md).AdminPostRegionsRegionFulfillmentProvidersReq + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md new file mode 100644 index 0000000000..4ce97948ed --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostRegionsRegionPaymentProvidersReq + +[internal](../modules/internal-17.md).AdminPostRegionsRegionPaymentProvidersReq + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionReq.md similarity index 54% rename from docs/content/references/js-client/classes/internal.AdminPostRegionsRegionReq.md rename to docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionReq.md index 42470e1300..246d73e88e 100644 --- a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionReq.md +++ b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsRegionReq.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: AdminPostRegionsRegionReq -[internal](../modules/internal.md).AdminPostRegionsRegionReq +[internal](../modules/internal-17.md).AdminPostRegionsRegionReq ## Properties @@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:70 +medusa/dist/api/routes/admin/regions/update-region.d.ts:70 ___ @@ -24,7 +20,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:74 +medusa/dist/api/routes/admin/regions/update-region.d.ts:74 ___ @@ -34,7 +30,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:66 +medusa/dist/api/routes/admin/regions/update-region.d.ts:66 ___ @@ -44,7 +40,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:73 +medusa/dist/api/routes/admin/regions/update-region.d.ts:73 ___ @@ -54,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:69 +medusa/dist/api/routes/admin/regions/update-region.d.ts:69 ___ @@ -64,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:65 +medusa/dist/api/routes/admin/regions/update-region.d.ts:65 ___ @@ -74,7 +70,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:72 +medusa/dist/api/routes/admin/regions/update-region.d.ts:72 ___ @@ -84,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:67 +medusa/dist/api/routes/admin/regions/update-region.d.ts:67 ___ @@ -94,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:71 +medusa/dist/api/routes/admin/regions/update-region.d.ts:71 ___ @@ -104,4 +100,4 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:68 +medusa/dist/api/routes/admin/regions/update-region.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-17.AdminPostRegionsReq.md b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsReq.md new file mode 100644 index 0000000000..0bff6f68e6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.AdminPostRegionsReq.md @@ -0,0 +1,73 @@ +# Class: AdminPostRegionsReq + +[internal](../modules/internal-17.md).AdminPostRegionsReq + +## Properties + +### countries + +• **countries**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:64 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:59 + +___ + +### fulfillment\_providers + +• **fulfillment\_providers**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:63 + +___ + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:58 + +___ + +### payment\_providers + +• **payment\_providers**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:62 + +___ + +### tax\_code + +• `Optional` **tax\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:60 + +___ + +### tax\_rate + +• **tax\_rate**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/regions/create-region.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal-17.AdminRegionsRes.md b/docs/content/references/js-client/classes/internal-17.AdminRegionsRes.md new file mode 100644 index 0000000000..22b62f2d71 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.AdminRegionsRes.md @@ -0,0 +1,13 @@ +# Class: AdminRegionsRes + +[internal](../modules/internal-17.md).AdminRegionsRes + +## Properties + +### region + +• **region**: [`Region`](internal.Region.md) + +#### Defined in + +medusa/dist/api/routes/admin/regions/index.d.ts:9 diff --git a/docs/content/references/js-client/classes/internal-17.FulfillmentOption.md b/docs/content/references/js-client/classes/internal-17.FulfillmentOption.md new file mode 100644 index 0000000000..6b8049e15b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-17.FulfillmentOption.md @@ -0,0 +1,23 @@ +# Class: FulfillmentOption + +[internal](../modules/internal-17.md).FulfillmentOption + +## Properties + +### options + +• **options**: `unknown`[] + +#### Defined in + +medusa/dist/api/routes/admin/regions/index.d.ts:17 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/regions/index.d.ts:16 diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReasonReq.md b/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReasonReq.md new file mode 100644 index 0000000000..45ecda11aa --- /dev/null +++ b/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReasonReq.md @@ -0,0 +1,43 @@ +# Class: AdminPostReturnReasonsReasonReq + +[internal](../modules/internal-18.md).AdminPostReturnReasonsReasonReq + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:40 + +___ + +### label + +• `Optional` **label**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:38 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:41 + +___ + +### value + +• `Optional` **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReq.md b/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReq.md new file mode 100644 index 0000000000..76e1125f8d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-18.AdminPostReturnReasonsReq.md @@ -0,0 +1,53 @@ +# Class: AdminPostReturnReasonsReq + +[internal](../modules/internal-18.md).AdminPostReturnReasonsReq + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:48 + +___ + +### label + +• **label**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:46 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:49 + +___ + +### parent\_return\_reason\_id + +• `Optional` **parent\_return\_reason\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:47 + +___ + +### value + +• **value**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal-19.AdminGetReturnsParams.md b/docs/content/references/js-client/classes/internal-19.AdminGetReturnsParams.md new file mode 100644 index 0000000000..a7b4f7b5d7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-19.AdminGetReturnsParams.md @@ -0,0 +1,23 @@ +# Class: AdminGetReturnsParams + +[internal](../modules/internal-19.md).AdminGetReturnsParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/returns/list-returns.d.ts:26 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/returns/list-returns.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-19.AdminPostReturnsReturnReceiveReq.md b/docs/content/references/js-client/classes/internal-19.AdminPostReturnsReturnReceiveReq.md new file mode 100644 index 0000000000..55d3248941 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-19.AdminPostReturnsReturnReceiveReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostReturnsReturnReceiveReq + +[internal](../modules/internal-19.md).AdminPostReturnsReturnReceiveReq + +## Properties + +### items + +• **items**: [`Item`](internal-19.Item.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/returns/receive-return.d.ts:48 + +___ + +### refund + +• `Optional` **refund**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/returns/receive-return.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal-19.Item.md b/docs/content/references/js-client/classes/internal-19.Item.md new file mode 100644 index 0000000000..5d870d770e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-19.Item.md @@ -0,0 +1,23 @@ +# Class: Item + +[internal](../modules/internal-19.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/returns/receive-return.d.ts:44 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/returns/receive-return.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md b/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md new file mode 100644 index 0000000000..8541c7d3e4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md @@ -0,0 +1,59 @@ +# Class: AdminGetBatchPaginationParams + +[internal](../modules/internal-2.md).AdminGetBatchPaginationParams + +## Hierarchy + +- **`AdminGetBatchPaginationParams`** + + ↳ [`AdminGetBatchParams`](internal-2.AdminGetBatchParams.md) + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:41 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:42 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:39 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:40 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:43 diff --git a/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md b/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md new file mode 100644 index 0000000000..534faca203 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md @@ -0,0 +1,169 @@ +# Class: AdminGetBatchParams + +[internal](../modules/internal-2.md).AdminGetBatchParams + +## Hierarchy + +- [`AdminGetBatchPaginationParams`](internal-2.AdminGetBatchPaginationParams.md) + + ↳ **`AdminGetBatchParams`** + +## Properties + +### canceled\_at + +• `Optional` **canceled\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:52 + +___ + +### completed\_at + +• `Optional` **completed\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:50 + +___ + +### confirmed\_at + +• `Optional` **confirmed\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:48 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:53 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[expand](internal-2.AdminGetBatchPaginationParams.md#expand) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:41 + +___ + +### failed\_at + +• `Optional` **failed\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:51 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[fields](internal-2.AdminGetBatchPaginationParams.md#fields) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:42 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:46 + +___ + +### limit + +• **limit**: `number` + +#### Inherited from + +[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[limit](internal-2.AdminGetBatchPaginationParams.md#limit) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:39 + +___ + +### offset + +• **offset**: `number` + +#### Inherited from + +[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[offset](internal-2.AdminGetBatchPaginationParams.md#offset) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:40 + +___ + +### order + +• `Optional` **order**: `string` + +#### Inherited from + +[AdminGetBatchPaginationParams](internal-2.AdminGetBatchPaginationParams.md).[order](internal-2.AdminGetBatchPaginationParams.md#order) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:43 + +___ + +### pre\_processed\_at + +• `Optional` **pre\_processed\_at**: ``null`` \| [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:49 + +___ + +### type + +• `Optional` **type**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:47 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md b/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md new file mode 100644 index 0000000000..59d10331ef --- /dev/null +++ b/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostBatchesReq + +[internal](../modules/internal-2.md).AdminPostBatchesReq + +## Properties + +### context + +• **context**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:28 + +___ + +### dry\_run + +• **dry\_run**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:29 + +___ + +### type + +• **type**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-2.BatchJob.md b/docs/content/references/js-client/classes/internal-2.BatchJob.md new file mode 100644 index 0000000000..20924da6f9 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-2.BatchJob.md @@ -0,0 +1,235 @@ +# Class: BatchJob + +[internal](../modules/internal-2.md).BatchJob + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`BatchJob`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:27 + +___ + +### canceled\_at + +• `Optional` **canceled\_at**: `Date` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:23 + +___ + +### completed\_at + +• `Optional` **completed\_at**: `Date` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:22 + +___ + +### confirmed\_at + +• `Optional` **confirmed\_at**: `Date` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:21 + +___ + +### context + +• **context**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/models/batch-job.d.ts:8 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### created\_by + +• **created\_by**: ``null`` \| `string` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:6 + +___ + +### created\_by\_user + +• **created\_by\_user**: [`User`](internal-1.User.md) + +#### Defined in + +medusa/dist/models/batch-job.d.ts:7 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### dry\_run + +• **dry\_run**: `boolean` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:18 + +___ + +### failed\_at + +• `Optional` **failed\_at**: `Date` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:24 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### pre\_processed\_at + +• `Optional` **pre\_processed\_at**: `Date` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:19 + +___ + +### processing\_at + +• `Optional` **processing\_at**: `Date` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:20 + +___ + +### result + +• **result**: { `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: [`BatchJobResultError`](../modules/internal-2.md#batchjobresulterror)[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: [`BatchJobResultStatDescriptor`](../modules/internal-2.md#batchjobresultstatdescriptor)[] } & `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/models/batch-job.d.ts:9 + +___ + +### status + +• **status**: [`BatchJobStatus`](../enums/internal-2.BatchJobStatus.md) + +#### Defined in + +medusa/dist/models/batch-job.d.ts:25 + +___ + +### type + +• **type**: `string` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:5 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:7 + +## Methods + +### loadStatus + +▸ **loadStatus**(): `void` + +#### Returns + +`void` + +#### Defined in + +medusa/dist/models/batch-job.d.ts:26 + +___ + +### toJSON + +▸ **toJSON**(): [`BatchJob`](internal-2.BatchJob.md) + +#### Returns + +[`BatchJob`](internal-2.BatchJob.md) + +#### Defined in + +medusa/dist/models/batch-job.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md b/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md new file mode 100644 index 0000000000..c22d487386 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md @@ -0,0 +1,43 @@ +# Class: DateComparisonOperator + +[internal](../modules/internal-2.md).DateComparisonOperator + +## Properties + +### gt + +• `Optional` **gt**: `Date` + +#### Defined in + +medusa/dist/types/common.d.ts:73 + +___ + +### gte + +• `Optional` **gte**: `Date` + +#### Defined in + +medusa/dist/types/common.d.ts:74 + +___ + +### lt + +• `Optional` **lt**: `Date` + +#### Defined in + +medusa/dist/types/common.d.ts:72 + +___ + +### lte + +• `Optional` **lte**: `Date` + +#### Defined in + +medusa/dist/types/common.d.ts:75 diff --git a/docs/content/references/js-client/classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md b/docs/content/references/js-client/classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md new file mode 100644 index 0000000000..23a32695a6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md @@ -0,0 +1,13 @@ +# Class: AdminDeleteSalesChannelsChannelProductsBatchReq + +[internal](../modules/internal-20.md).AdminDeleteSalesChannelsChannelProductsBatchReq + +## Properties + +### product\_ids + +• **product\_ids**: [`ProductBatchSalesChannel`](internal-20.ProductBatchSalesChannel.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/delete-products-batch.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-20.AdminGetSalesChannelsParams.md b/docs/content/references/js-client/classes/internal-20.AdminGetSalesChannelsParams.md new file mode 100644 index 0000000000..5352f3d239 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-20.AdminGetSalesChannelsParams.md @@ -0,0 +1,145 @@ +# Class: AdminGetSalesChannelsParams + +[internal](../modules/internal-20.md).AdminGetSalesChannelsParams + +## Hierarchy + +- [`AdminGetSalesChannelsParams_base`](../modules/internal-20.md#admingetsaleschannelsparams_base) + + ↳ **`AdminGetSalesChannelsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:53 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:55 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:52 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +AdminGetSalesChannelsParams\_base.expand + +#### Defined in + +medusa/dist/types/common.d.ts:116 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +AdminGetSalesChannelsParams\_base.fields + +#### Defined in + +medusa/dist/types/common.d.ts:117 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:49 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +AdminGetSalesChannelsParams\_base.limit + +#### Defined in + +medusa/dist/types/common.d.ts:121 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:51 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +AdminGetSalesChannelsParams\_base.offset + +#### Defined in + +medusa/dist/types/common.d.ts:120 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:56 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:50 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md new file mode 100644 index 0000000000..97ed597197 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostSalesChannelsChannelProductsBatchReq + +[internal](../modules/internal-20.md).AdminPostSalesChannelsChannelProductsBatchReq + +## Properties + +### product\_ids + +• **product\_ids**: [`ProductBatchSalesChannel`](internal-20.ProductBatchSalesChannel.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/add-product-batch.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsReq.md new file mode 100644 index 0000000000..df9a8ee172 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostSalesChannelsReq + +[internal](../modules/internal-20.md).AdminPostSalesChannelsReq + +## Properties + +### description + +• **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:27 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:28 + +___ + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md b/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md new file mode 100644 index 0000000000..60f2859c4f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostSalesChannelsSalesChannelReq + +[internal](../modules/internal-20.md).AdminPostSalesChannelsSalesChannelReq + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:40 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:41 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-20.ProductBatchSalesChannel.md b/docs/content/references/js-client/classes/internal-20.ProductBatchSalesChannel.md new file mode 100644 index 0000000000..57d96c830c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-20.ProductBatchSalesChannel.md @@ -0,0 +1,13 @@ +# Class: ProductBatchSalesChannel + +[internal](../modules/internal-20.md).ProductBatchSalesChannel + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +medusa/dist/types/sales-channels.d.ts:8 diff --git a/docs/content/references/js-client/classes/internal-21.AdminGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-21.AdminGetShippingOptionsParams.md new file mode 100644 index 0000000000..cfb73e7a97 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.AdminGetShippingOptionsParams.md @@ -0,0 +1,33 @@ +# Class: AdminGetShippingOptionsParams + +[internal](../modules/internal-21.md).AdminGetShippingOptionsParams + +## Properties + +### admin\_only + +• `Optional` **admin\_only**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:45 + +___ + +### is\_return + +• `Optional` **is\_return**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:44 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:43 diff --git a/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsOptionReq.md b/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsOptionReq.md new file mode 100644 index 0000000000..d6808ba57f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsOptionReq.md @@ -0,0 +1,53 @@ +# Class: AdminPostShippingOptionsOptionReq + +[internal](../modules/internal-21.md).AdminPostShippingOptionsOptionReq + +## Properties + +### admin\_only + +• `Optional` **admin\_only**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:63 + +___ + +### amount + +• `Optional` **amount**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:61 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:64 + +___ + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:60 + +___ + +### requirements + +• **requirements**: [`OptionRequirement`](internal-21.OptionRequirement-1.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:62 diff --git a/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsReq.md new file mode 100644 index 0000000000..e23bf46fda --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.AdminPostShippingOptionsReq.md @@ -0,0 +1,113 @@ +# Class: AdminPostShippingOptionsReq + +[internal](../modules/internal-21.md).AdminPostShippingOptionsReq + +## Properties + +### admin\_only + +• `Optional` **admin\_only**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:86 + +___ + +### amount + +• `Optional` **amount**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:84 + +___ + +### data + +• **data**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:82 + +___ + +### is\_return + +• `Optional` **is\_return**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:87 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:88 + +___ + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:78 + +___ + +### price\_type + +• **price\_type**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:83 + +___ + +### profile\_id + +• `Optional` **profile\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:81 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:80 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:79 + +___ + +### requirements + +• `Optional` **requirements**: [`OptionRequirement`](internal-21.OptionRequirement.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal-21.OptionRequirement-1.md b/docs/content/references/js-client/classes/internal-21.OptionRequirement-1.md new file mode 100644 index 0000000000..6f5ae9a4da --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.OptionRequirement-1.md @@ -0,0 +1,33 @@ +# Class: OptionRequirement + +[internal](../modules/internal-21.md).OptionRequirement + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:57 + +___ + +### id + +• **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:55 + +___ + +### type + +• **type**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:56 diff --git a/docs/content/references/js-client/classes/internal-21.OptionRequirement.md b/docs/content/references/js-client/classes/internal-21.OptionRequirement.md new file mode 100644 index 0000000000..5dcc885f3c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-21.OptionRequirement.md @@ -0,0 +1,23 @@ +# Class: OptionRequirement + +[internal](../modules/internal-21.md).OptionRequirement + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:75 + +___ + +### type + +• **type**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:74 diff --git a/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesProfileReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesProfileReq.md new file mode 100644 index 0000000000..258960e155 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesProfileReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostShippingProfilesProfileReq + +[internal](../modules/internal-22.md).AdminPostShippingProfilesProfileReq + +## Properties + +### name + +• `Optional` **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesReq.md b/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesReq.md new file mode 100644 index 0000000000..0c6ad30a9b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-22.AdminPostShippingProfilesReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostShippingProfilesReq + +[internal](../modules/internal-22.md).AdminPostShippingProfilesReq + +## Properties + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminPostStoreReq.md b/docs/content/references/js-client/classes/internal-23.AdminPostStoreReq.md similarity index 52% rename from docs/content/references/js-client/classes/internal.AdminPostStoreReq.md rename to docs/content/references/js-client/classes/internal-23.AdminPostStoreReq.md index 569d16177d..c2f01a6630 100644 --- a/docs/content/references/js-client/classes/internal.AdminPostStoreReq.md +++ b/docs/content/references/js-client/classes/internal-23.AdminPostStoreReq.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: AdminPostStoreReq -[internal](../modules/internal.md).AdminPostStoreReq +[internal](../modules/internal-23.md).AdminPostStoreReq ## Properties @@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/api/routes/admin/store/update-store.d.ts:47 +medusa/dist/api/routes/admin/store/update-store.d.ts:47 ___ @@ -24,7 +20,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/store/update-store.d.ts:46 +medusa/dist/api/routes/admin/store/update-store.d.ts:46 ___ @@ -34,7 +30,17 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/store/update-store.d.ts:45 +medusa/dist/api/routes/admin/store/update-store.d.ts:45 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/store/update-store.d.ts:48 ___ @@ -44,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/store/update-store.d.ts:42 +medusa/dist/api/routes/admin/store/update-store.d.ts:42 ___ @@ -54,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/store/update-store.d.ts:44 +medusa/dist/api/routes/admin/store/update-store.d.ts:44 ___ @@ -64,4 +70,4 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/store/update-store.d.ts:43 +medusa/dist/api/routes/admin/store/update-store.d.ts:43 diff --git a/docs/content/references/js-client/classes/internal.Store.md b/docs/content/references/js-client/classes/internal-23.Store.md similarity index 58% rename from docs/content/references/js-client/classes/internal.Store.md rename to docs/content/references/js-client/classes/internal-23.Store.md index 2255b3bf0b..e579e2b576 100644 --- a/docs/content/references/js-client/classes/internal.Store.md +++ b/docs/content/references/js-client/classes/internal-23.Store.md @@ -1,10 +1,8 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: Store -[internal](../modules/internal.md).Store +[internal](../modules/internal-23.md).Store + +Base abstract entity for all entities ## Hierarchy @@ -20,13 +18,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/store.d.ts:12 +medusa/dist/models/store.d.ts:15 ___ ### 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,7 +42,7 @@ ___ #### Defined in -packages/medusa/dist/models/store.d.ts:7 +medusa/dist/models/store.d.ts:8 ___ @@ -54,7 +52,7 @@ ___ #### Defined in -packages/medusa/dist/models/store.d.ts:6 +medusa/dist/models/store.d.ts:7 ___ @@ -64,7 +62,27 @@ ___ #### Defined in -packages/medusa/dist/models/store.d.ts:5 +medusa/dist/models/store.d.ts:6 + +___ + +### default\_sales\_channel + +• **default\_sales\_channel**: [`SalesChannel`](internal.SalesChannel.md) + +#### Defined in + +medusa/dist/models/store.d.ts:14 + +___ + +### default\_sales\_channel\_id + +• **default\_sales\_channel\_id**: `string` + +#### Defined in + +medusa/dist/models/store.d.ts:13 ___ @@ -78,7 +96,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -88,17 +106,17 @@ ___ #### Defined in -packages/medusa/dist/models/store.d.ts:10 +medusa/dist/models/store.d.ts:11 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/store.d.ts:11 +medusa/dist/models/store.d.ts:12 ___ @@ -108,7 +126,7 @@ ___ #### Defined in -packages/medusa/dist/models/store.d.ts:4 +medusa/dist/models/store.d.ts:5 ___ @@ -118,7 +136,7 @@ ___ #### Defined in -packages/medusa/dist/models/store.d.ts:9 +medusa/dist/models/store.d.ts:10 ___ @@ -128,13 +146,13 @@ ___ #### Defined in -packages/medusa/dist/models/store.d.ts:8 +medusa/dist/models/store.d.ts:9 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -142,4 +160,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal-24.AdminGetSwapsParams.md b/docs/content/references/js-client/classes/internal-24.AdminGetSwapsParams.md new file mode 100644 index 0000000000..c4ca18be75 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-24.AdminGetSwapsParams.md @@ -0,0 +1,23 @@ +# Class: AdminGetSwapsParams + +[internal](../modules/internal-24.md).AdminGetSwapsParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:24 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md new file mode 100644 index 0000000000..71150ef855 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md @@ -0,0 +1,23 @@ +# Class: AdminDeleteTaxRatesTaxRateProductTypesParams + +[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateProductTypesParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:27 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md new file mode 100644 index 0000000000..48411a7087 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md @@ -0,0 +1,13 @@ +# Class: AdminDeleteTaxRatesTaxRateProductTypesReq + +[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateProductTypesReq + +## Properties + +### product\_types + +• **product\_types**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md new file mode 100644 index 0000000000..d0b8c5b39e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md @@ -0,0 +1,23 @@ +# Class: AdminDeleteTaxRatesTaxRateProductsParams + +[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateProductsParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:27 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md new file mode 100644 index 0000000000..f18af7f4fb --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md @@ -0,0 +1,13 @@ +# Class: AdminDeleteTaxRatesTaxRateProductsReq + +[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateProductsReq + +## Properties + +### products + +• **products**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md new file mode 100644 index 0000000000..fb9152dda6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md @@ -0,0 +1,23 @@ +# Class: AdminDeleteTaxRatesTaxRateShippingOptionsParams + +[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:27 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md new file mode 100644 index 0000000000..2fbd14deb6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md @@ -0,0 +1,13 @@ +# Class: AdminDeleteTaxRatesTaxRateShippingOptionsReq + +[internal](../modules/internal-25.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq + +## Properties + +### shipping\_options + +• **shipping\_options**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesParams.md b/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesParams.md new file mode 100644 index 0000000000..9461c6c88d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesParams.md @@ -0,0 +1,83 @@ +# Class: AdminGetTaxRatesParams + +[internal](../modules/internal-25.md).AdminGetTaxRatesParams + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:38 + +___ + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:42 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:43 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:41 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:37 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:40 + +___ + +### rate + +• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal-25.NumericalComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:39 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` \| `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesTaxRateParams.md b/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesTaxRateParams.md new file mode 100644 index 0000000000..46fac54516 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminGetTaxRatesTaxRateParams.md @@ -0,0 +1,23 @@ +# Class: AdminGetTaxRatesTaxRateParams + +[internal](../modules/internal-25.md).AdminGetTaxRatesTaxRateParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:24 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesReq.md new file mode 100644 index 0000000000..4bc7388cb3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesReq.md @@ -0,0 +1,73 @@ +# Class: AdminPostTaxRatesReq + +[internal](../modules/internal-25.md).AdminPostTaxRatesReq + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:24 + +___ + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:25 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:30 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:28 + +___ + +### rate + +• `Optional` **rate**: ``null`` \| `number` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:27 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:26 + +___ + +### shipping\_options + +• `Optional` **shipping\_options**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md new file mode 100644 index 0000000000..3c2b1dc12c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostTaxRatesTaxRateProductTypesReq + +[internal](../modules/internal-25.md).AdminPostTaxRatesTaxRateProductTypesReq + +## Properties + +### product\_types + +• **product\_types**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md new file mode 100644 index 0000000000..75c0464cdb --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostTaxRatesTaxRateProductsReq + +[internal](../modules/internal-25.md).AdminPostTaxRatesTaxRateProductsReq + +## Properties + +### products + +• **products**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateReq.md new file mode 100644 index 0000000000..255e42ff7d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateReq.md @@ -0,0 +1,73 @@ +# Class: AdminPostTaxRatesTaxRateReq + +[internal](../modules/internal-25.md).AdminPostTaxRatesTaxRateReq + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:24 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:25 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:30 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:28 + +___ + +### rate + +• `Optional` **rate**: ``null`` \| `number` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:27 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:26 + +___ + +### shipping\_options + +• `Optional` **shipping\_options**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md new file mode 100644 index 0000000000..6dd793ad10 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostTaxRatesTaxRateShippingOptionsReq + +[internal](../modules/internal-25.md).AdminPostTaxRatesTaxRateShippingOptionsReq + +## Properties + +### shipping\_options + +• **shipping\_options**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.NumericalComparisonOperator.md b/docs/content/references/js-client/classes/internal-25.NumericalComparisonOperator.md similarity index 52% rename from docs/content/references/js-client/classes/internal.NumericalComparisonOperator.md rename to docs/content/references/js-client/classes/internal-25.NumericalComparisonOperator.md index 61518cf608..00b0d56ea8 100644 --- a/docs/content/references/js-client/classes/internal.NumericalComparisonOperator.md +++ b/docs/content/references/js-client/classes/internal-25.NumericalComparisonOperator.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: NumericalComparisonOperator -[internal](../modules/internal.md).NumericalComparisonOperator +[internal](../modules/internal-25.md).NumericalComparisonOperator ## Properties @@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/common.d.ts:58 +medusa/dist/types/common.d.ts:85 ___ @@ -24,7 +20,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:59 +medusa/dist/types/common.d.ts:86 ___ @@ -34,7 +30,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:57 +medusa/dist/types/common.d.ts:84 ___ @@ -44,4 +40,4 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:60 +medusa/dist/types/common.d.ts:87 diff --git a/docs/content/references/js-client/classes/internal-26.AdminDeleteUploadsReq.md b/docs/content/references/js-client/classes/internal-26.AdminDeleteUploadsReq.md new file mode 100644 index 0000000000..c96ea18867 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-26.AdminDeleteUploadsReq.md @@ -0,0 +1,13 @@ +# Class: AdminDeleteUploadsReq + +[internal](../modules/internal-26.md).AdminDeleteUploadsReq + +## Properties + +### file\_key + +• **file\_key**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/uploads/delete-upload.d.ts:16 diff --git a/docs/content/references/js-client/classes/internal-26.AdminPostUploadsDownloadUrlReq.md b/docs/content/references/js-client/classes/internal-26.AdminPostUploadsDownloadUrlReq.md new file mode 100644 index 0000000000..b3797a2c70 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-26.AdminPostUploadsDownloadUrlReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostUploadsDownloadUrlReq + +[internal](../modules/internal-26.md).AdminPostUploadsDownloadUrlReq + +## Properties + +### file\_key + +• **file\_key**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/uploads/get-download-url.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-26.IAdminPostUploadsFileReq.md b/docs/content/references/js-client/classes/internal-26.IAdminPostUploadsFileReq.md new file mode 100644 index 0000000000..3f549b9524 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-26.IAdminPostUploadsFileReq.md @@ -0,0 +1,23 @@ +# Class: IAdminPostUploadsFileReq + +[internal](../modules/internal-26.md).IAdminPostUploadsFileReq + +## Properties + +### originalName + +• **originalName**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/uploads/create-upload.d.ts:21 + +___ + +### path + +• **path**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/uploads/create-upload.d.ts:22 diff --git a/docs/content/references/js-client/classes/internal-27.AdminCreateUserRequest.md b/docs/content/references/js-client/classes/internal-27.AdminCreateUserRequest.md new file mode 100644 index 0000000000..5a3f6e9da1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-27.AdminCreateUserRequest.md @@ -0,0 +1,53 @@ +# Class: AdminCreateUserRequest + +[internal](../modules/internal-27.md).AdminCreateUserRequest + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/create-user.d.ts:46 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/create-user.d.ts:47 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/create-user.d.ts:48 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/create-user.d.ts:50 + +___ + +### role + +• `Optional` **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +medusa/dist/api/routes/admin/users/create-user.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal-27.AdminResetPasswordRequest.md b/docs/content/references/js-client/classes/internal-27.AdminResetPasswordRequest.md new file mode 100644 index 0000000000..6b2e282860 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-27.AdminResetPasswordRequest.md @@ -0,0 +1,33 @@ +# Class: AdminResetPasswordRequest + +[internal](../modules/internal-27.md).AdminResetPasswordRequest + +## Properties + +### email + +• `Optional` **email**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/reset-password.d.ts:45 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/reset-password.d.ts:47 + +___ + +### token + +• **token**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/reset-password.d.ts:46 diff --git a/docs/content/references/js-client/classes/internal-27.AdminResetPasswordTokenRequest.md b/docs/content/references/js-client/classes/internal-27.AdminResetPasswordTokenRequest.md new file mode 100644 index 0000000000..cebfb0a8d2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-27.AdminResetPasswordTokenRequest.md @@ -0,0 +1,13 @@ +# Class: AdminResetPasswordTokenRequest + +[internal](../modules/internal-27.md).AdminResetPasswordTokenRequest + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/reset-password-token.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal-27.AdminUpdateUserRequest.md b/docs/content/references/js-client/classes/internal-27.AdminUpdateUserRequest.md new file mode 100644 index 0000000000..e8e4326c6f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-27.AdminUpdateUserRequest.md @@ -0,0 +1,53 @@ +# Class: AdminUpdateUserRequest + +[internal](../modules/internal-27.md).AdminUpdateUserRequest + +## Properties + +### api\_token + +• `Optional` **api\_token**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/update-user.d.ts:32 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/update-user.d.ts:29 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/users/update-user.d.ts:30 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/users/update-user.d.ts:33 + +___ + +### role + +• `Optional` **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +medusa/dist/api/routes/admin/users/update-user.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal-28.AdminGetVariantsParams.md b/docs/content/references/js-client/classes/internal-28.AdminGetVariantsParams.md new file mode 100644 index 0000000000..6c5c58c140 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-28.AdminGetVariantsParams.md @@ -0,0 +1,33 @@ +# Class: AdminGetVariantsParams + +[internal](../modules/internal-28.md).AdminGetVariantsParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/variants/list-variants.d.ts:29 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/variants/list-variants.d.ts:30 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/variants/list-variants.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal-29.StorePostAuthReq.md b/docs/content/references/js-client/classes/internal-29.StorePostAuthReq.md new file mode 100644 index 0000000000..f81d2481bb --- /dev/null +++ b/docs/content/references/js-client/classes/internal-29.StorePostAuthReq.md @@ -0,0 +1,23 @@ +# Class: StorePostAuthReq + +[internal](../modules/internal-29.md).StorePostAuthReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/auth/create-session.d.ts:24 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/store/auth/create-session.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md b/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md new file mode 100644 index 0000000000..71c38ae5d4 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md @@ -0,0 +1,29 @@ +# Class: AdminGetCollectionsPaginationParams + +[internal](../modules/internal-3.md).AdminGetCollectionsPaginationParams + +## Hierarchy + +- **`AdminGetCollectionsPaginationParams`** + + ↳ [`AdminGetCollectionsParams`](internal-3.AdminGetCollectionsParams.md) + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:32 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:33 diff --git a/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md b/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md new file mode 100644 index 0000000000..a213cd0b9e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md @@ -0,0 +1,97 @@ +# Class: AdminGetCollectionsParams + +[internal](../modules/internal-3.md).AdminGetCollectionsParams + +## Hierarchy + +- [`AdminGetCollectionsPaginationParams`](internal-3.AdminGetCollectionsPaginationParams.md) + + ↳ **`AdminGetCollectionsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:38 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:40 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:37 + +___ + +### limit + +• **limit**: `number` + +#### Inherited from + +[AdminGetCollectionsPaginationParams](internal-3.AdminGetCollectionsPaginationParams.md).[limit](internal-3.AdminGetCollectionsPaginationParams.md#limit) + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:32 + +___ + +### offset + +• **offset**: `number` + +#### Inherited from + +[AdminGetCollectionsPaginationParams](internal-3.AdminGetCollectionsPaginationParams.md).[offset](internal-3.AdminGetCollectionsPaginationParams.md#offset) + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:33 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:41 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:36 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/collections/list-collections.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md b/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md new file mode 100644 index 0000000000..321139ae7f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostCollectionsCollectionReq + +[internal](../modules/internal-3.md).AdminPostCollectionsCollectionReq + +## Properties + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/collections/update-collection.d.ts:40 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/collections/update-collection.d.ts:41 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/collections/update-collection.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md b/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md new file mode 100644 index 0000000000..3f2cd1d483 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostCollectionsReq + +[internal](../modules/internal-3.md).AdminPostCollectionsReq + +## Properties + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/collections/create-collection.d.ts:40 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/collections/create-collection.d.ts:41 + +___ + +### title + +• **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/collections/create-collection.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-30.Discount.md b/docs/content/references/js-client/classes/internal-30.Discount.md new file mode 100644 index 0000000000..986e7508ad --- /dev/null +++ b/docs/content/references/js-client/classes/internal-30.Discount.md @@ -0,0 +1,13 @@ +# Class: Discount + +[internal](../modules/internal-30.md).Discount + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:78 diff --git a/docs/content/references/js-client/classes/internal-30.GiftCard.md b/docs/content/references/js-client/classes/internal-30.GiftCard.md new file mode 100644 index 0000000000..0f60af116d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-30.GiftCard.md @@ -0,0 +1,13 @@ +# Class: GiftCard + +[internal](../modules/internal-30.md).GiftCard + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:75 diff --git a/docs/content/references/js-client/classes/internal-30.Item.md b/docs/content/references/js-client/classes/internal-30.Item.md new file mode 100644 index 0000000000..e052cf2934 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-30.Item.md @@ -0,0 +1,23 @@ +# Class: Item + +[internal](../modules/internal-30.md).Item + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/store/carts/create-cart.d.ts:53 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/create-cart.d.ts:52 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartReq.md b/docs/content/references/js-client/classes/internal-30.StorePostCartReq.md new file mode 100644 index 0000000000..89d18d2ccf --- /dev/null +++ b/docs/content/references/js-client/classes/internal-30.StorePostCartReq.md @@ -0,0 +1,53 @@ +# Class: StorePostCartReq + +[internal](../modules/internal-30.md).StorePostCartReq + +## Properties + +### context + +• `Optional` **context**: `object` + +#### Defined in + +medusa/dist/api/routes/store/carts/create-cart.d.ts:59 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/create-cart.d.ts:57 + +___ + +### items + +• `Optional` **items**: [`Item`](internal-30.Item.md)[] + +#### Defined in + +medusa/dist/api/routes/store/carts/create-cart.d.ts:58 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/create-cart.d.ts:56 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/create-cart.d.ts:60 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionReq.md b/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionReq.md new file mode 100644 index 0000000000..5080e0b5d2 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionReq.md @@ -0,0 +1,13 @@ +# Class: StorePostCartsCartPaymentSessionReq + +[internal](../modules/internal-30.md).StorePostCartsCartPaymentSessionReq + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/set-payment-session.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md b/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md new file mode 100644 index 0000000000..441abc549c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md @@ -0,0 +1,13 @@ +# Class: StorePostCartsCartPaymentSessionUpdateReq + +[internal](../modules/internal-30.md).StorePostCartsCartPaymentSessionUpdateReq + +## Properties + +### data + +• **data**: `object` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-payment-session.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartReq.md b/docs/content/references/js-client/classes/internal-30.StorePostCartsCartReq.md new file mode 100644 index 0000000000..ced61337ba --- /dev/null +++ b/docs/content/references/js-client/classes/internal-30.StorePostCartsCartReq.md @@ -0,0 +1,103 @@ +# Class: StorePostCartsCartReq + +[internal](../modules/internal-30.md).StorePostCartsCartReq + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:84 + +___ + +### context + +• `Optional` **context**: `object` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:89 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:82 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:88 + +___ + +### discounts + +• `Optional` **discounts**: [`Discount`](internal-30.Discount.md)[] + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:87 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:83 + +___ + +### gift\_cards + +• `Optional` **gift\_cards**: [`GiftCard`](internal-30.GiftCard.md)[] + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:86 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:81 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:90 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +medusa/dist/api/routes/store/carts/update-cart.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal-30.StorePostCartsCartShippingMethodReq.md b/docs/content/references/js-client/classes/internal-30.StorePostCartsCartShippingMethodReq.md new file mode 100644 index 0000000000..a0e2622bd7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-30.StorePostCartsCartShippingMethodReq.md @@ -0,0 +1,23 @@ +# Class: StorePostCartsCartShippingMethodReq + +[internal](../modules/internal-30.md).StorePostCartsCartShippingMethodReq + +## Properties + +### data + +• `Optional` **data**: `Record`<`string`, `any`\> + +#### Defined in + +medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:26 + +___ + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal-31.StoreGetCollectionsParams.md b/docs/content/references/js-client/classes/internal-31.StoreGetCollectionsParams.md new file mode 100644 index 0000000000..a8efffecde --- /dev/null +++ b/docs/content/references/js-client/classes/internal-31.StoreGetCollectionsParams.md @@ -0,0 +1,43 @@ +# Class: StoreGetCollectionsParams + +[internal](../modules/internal-31.md).StoreGetCollectionsParams + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/store/collections/list-collections.d.ts:27 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/store/collections/list-collections.d.ts:25 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/store/collections/list-collections.d.ts:26 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/store/collections/list-collections.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersParams.md b/docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersParams.md new file mode 100644 index 0000000000..a41e23bc7f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-32.StoreGetCustomersCustomerOrdersParams.md @@ -0,0 +1,43 @@ +# Class: StoreGetCustomersCustomerOrdersParams + +[internal](../modules/internal-32.md).StoreGetCustomersCustomerOrdersParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/list-orders.d.ts:41 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/list-orders.d.ts:40 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/store/customers/list-orders.d.ts:38 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/store/customers/list-orders.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md new file mode 100644 index 0000000000..b6d2a7b861 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md @@ -0,0 +1,13 @@ +# Class: StorePostCustomersCustomerPasswordTokenReq + +[internal](../modules/internal-32.md).StorePostCustomersCustomerPasswordTokenReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/reset-password-token.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerReq.md new file mode 100644 index 0000000000..bc6051409e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-32.StorePostCustomersCustomerReq.md @@ -0,0 +1,73 @@ +# Class: StorePostCustomersCustomerReq + +[internal](../modules/internal-32.md).StorePostCustomersCustomerReq + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +medusa/dist/api/routes/store/customers/update-customer.d.ts:50 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/update-customer.d.ts:55 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/update-customer.d.ts:51 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/update-customer.d.ts:52 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/store/customers/update-customer.d.ts:56 + +___ + +### password + +• `Optional` **password**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/update-customer.d.ts:53 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/update-customer.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal-32.StorePostCustomersReq.md b/docs/content/references/js-client/classes/internal-32.StorePostCustomersReq.md new file mode 100644 index 0000000000..0c3a709ef7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-32.StorePostCustomersReq.md @@ -0,0 +1,53 @@ +# Class: StorePostCustomersReq + +[internal](../modules/internal-32.md).StorePostCustomersReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:29 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:27 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:28 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:30 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +medusa/dist/api/routes/store/customers/create-customer.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsItemReq.md b/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsItemReq.md new file mode 100644 index 0000000000..454704df6c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsItemReq.md @@ -0,0 +1,13 @@ +# Class: StorePostCartsCartLineItemsItemReq + +[internal](../modules/internal-34.md).StorePostCartsCartLineItemsItemReq + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/store/carts/update-line-item.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsReq.md b/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsReq.md new file mode 100644 index 0000000000..78018f29e6 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-34.StorePostCartsCartLineItemsReq.md @@ -0,0 +1,33 @@ +# Class: StorePostCartsCartLineItemsReq + +[internal](../modules/internal-34.md).StorePostCartsCartLineItemsReq + +## Properties + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/store/carts/create-line-item.d.ts:29 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/store/carts/create-line-item.d.ts:28 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/carts/create-line-item.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-35.ShippingAddressPayload.md b/docs/content/references/js-client/classes/internal-35.ShippingAddressPayload.md new file mode 100644 index 0000000000..fb82a47a12 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-35.ShippingAddressPayload.md @@ -0,0 +1,13 @@ +# Class: ShippingAddressPayload + +[internal](../modules/internal-35.md).ShippingAddressPayload + +## Properties + +### postal\_code + +• `Optional` **postal\_code**: `string` + +#### Defined in + +medusa/dist/api/routes/store/orders/lookup-order.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal-35.StoreGetOrdersParams.md b/docs/content/references/js-client/classes/internal-35.StoreGetOrdersParams.md new file mode 100644 index 0000000000..306fe25100 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-35.StoreGetOrdersParams.md @@ -0,0 +1,33 @@ +# Class: StoreGetOrdersParams + +[internal](../modules/internal-35.md).StoreGetOrdersParams + +## Properties + +### display\_id + +• **display\_id**: `number` + +#### Defined in + +medusa/dist/api/routes/store/orders/lookup-order.d.ts:27 + +___ + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/store/orders/lookup-order.d.ts:28 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal-35.ShippingAddressPayload.md) + +#### Defined in + +medusa/dist/api/routes/store/orders/lookup-order.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal-37.PriceSelectionParams.md b/docs/content/references/js-client/classes/internal-37.PriceSelectionParams.md new file mode 100644 index 0000000000..6636bf95dc --- /dev/null +++ b/docs/content/references/js-client/classes/internal-37.PriceSelectionParams.md @@ -0,0 +1,41 @@ +# Class: PriceSelectionParams + +[internal](../modules/internal-37.md).PriceSelectionParams + +## Hierarchy + +- **`PriceSelectionParams`** + + ↳ [`StoreGetVariantsParams`](internal-37.StoreGetVariantsParams.md) + + ↳ [`StoreGetProductsPaginationParams`](internal-38.StoreGetProductsPaginationParams.md) + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Defined in + +medusa/dist/types/price-selection.d.ts:2 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +medusa/dist/types/price-selection.d.ts:4 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +medusa/dist/types/price-selection.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal-37.StoreGetVariantsParams.md b/docs/content/references/js-client/classes/internal-37.StoreGetVariantsParams.md new file mode 100644 index 0000000000..b79327168b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-37.StoreGetVariantsParams.md @@ -0,0 +1,121 @@ +# Class: StoreGetVariantsParams + +[internal](../modules/internal-37.md).StoreGetVariantsParams + +## Hierarchy + +- [`PriceSelectionParams`](internal-37.PriceSelectionParams.md) + + ↳ **`StoreGetVariantsParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-37.PriceSelectionParams.md).[cart_id](internal-37.PriceSelectionParams.md#cart_id) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:2 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-37.PriceSelectionParams.md).[currency_code](internal-37.PriceSelectionParams.md#currency_code) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:4 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/store/variants/list-variants.d.ts:32 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +medusa/dist/api/routes/store/variants/list-variants.d.ts:34 + +___ + +### ids + +• `Optional` **ids**: `string` + +#### Defined in + +medusa/dist/api/routes/store/variants/list-variants.d.ts:33 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-25.NumericalComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/store/variants/list-variants.d.ts:36 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/store/variants/list-variants.d.ts:30 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/store/variants/list-variants.d.ts:31 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-37.PriceSelectionParams.md).[region_id](internal-37.PriceSelectionParams.md#region_id) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:3 + +___ + +### title + +• `Optional` **title**: `string` \| `string`[] + +#### Defined in + +medusa/dist/api/routes/store/variants/list-variants.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal-38.StoreGetProductsPaginationParams.md b/docs/content/references/js-client/classes/internal-38.StoreGetProductsPaginationParams.md new file mode 100644 index 0000000000..aeb8a4f336 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-38.StoreGetProductsPaginationParams.md @@ -0,0 +1,93 @@ +# Class: StoreGetProductsPaginationParams + +[internal](../modules/internal-38.md).StoreGetProductsPaginationParams + +## Hierarchy + +- [`PriceSelectionParams`](internal-37.PriceSelectionParams.md) + + ↳ **`StoreGetProductsPaginationParams`** + + ↳↳ [`StoreGetProductsParams`](internal-38.StoreGetProductsParams.md) + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-37.PriceSelectionParams.md).[cart_id](internal-37.PriceSelectionParams.md#cart_id) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:2 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-37.PriceSelectionParams.md).[currency_code](internal-37.PriceSelectionParams.md#currency_code) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:4 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:50 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:49 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:52 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:51 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-37.PriceSelectionParams.md).[region_id](internal-37.PriceSelectionParams.md#region_id) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal-38.StoreGetProductsParams.md b/docs/content/references/js-client/classes/internal-38.StoreGetProductsParams.md new file mode 100644 index 0000000000..cd7e1fe9f1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-38.StoreGetProductsParams.md @@ -0,0 +1,217 @@ +# Class: StoreGetProductsParams + +[internal](../modules/internal-38.md).StoreGetProductsParams + +## Hierarchy + +- [`StoreGetProductsPaginationParams`](internal-38.StoreGetProductsPaginationParams.md) + + ↳ **`StoreGetProductsParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[cart_id](internal-38.StoreGetProductsPaginationParams.md#cart_id) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:2 + +___ + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:57 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:64 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[currency_code](internal-38.StoreGetProductsPaginationParams.md#currency_code) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:4 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:60 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[expand](internal-38.StoreGetProductsPaginationParams.md#expand) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:50 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[fields](internal-38.StoreGetProductsPaginationParams.md#fields) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:49 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:61 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:55 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `boolean` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:62 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[limit](internal-38.StoreGetProductsPaginationParams.md#limit) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:52 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[offset](internal-38.StoreGetProductsPaginationParams.md#offset) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:51 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:56 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-38.StoreGetProductsPaginationParams.md).[region_id](internal-38.StoreGetProductsPaginationParams.md#region_id) + +#### Defined in + +medusa/dist/types/price-selection.d.ts:3 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:58 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:59 + +___ + +### type + +• `Optional` **type**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:63 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/api/routes/store/products/list-products.d.ts:65 diff --git a/docs/content/references/js-client/classes/internal-38.StorePostSearchReq.md b/docs/content/references/js-client/classes/internal-38.StorePostSearchReq.md new file mode 100644 index 0000000000..e910d499c7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-38.StorePostSearchReq.md @@ -0,0 +1,43 @@ +# Class: StorePostSearchReq + +[internal](../modules/internal-38.md).StorePostSearchReq + +## Properties + +### filter + +• `Optional` **filter**: `unknown` + +#### Defined in + +medusa/dist/api/routes/store/products/search.d.ts:7 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/store/products/search.d.ts:6 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/store/products/search.d.ts:5 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/store/products/search.d.ts:4 diff --git a/docs/content/references/js-client/classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md b/docs/content/references/js-client/classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md new file mode 100644 index 0000000000..1b8c55f7c5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md @@ -0,0 +1,13 @@ +# Class: AdminDeleteCustomerGroupsGroupCustomerBatchReq + +[internal](../modules/internal-4.md).AdminDeleteCustomerGroupsGroupCustomerBatchReq + +## Properties + +### customer\_ids + +• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-4.CustomerGroupsBatchCustomer.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsGroupParams.md b/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsGroupParams.md new file mode 100644 index 0000000000..36c0b60b39 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsGroupParams.md @@ -0,0 +1,37 @@ +# Class: AdminGetCustomerGroupsGroupParams + +[internal](../modules/internal-4.md).AdminGetCustomerGroupsGroupParams + +## Hierarchy + +- [`FindParams`](internal-4.FindParams.md) + + ↳ **`AdminGetCustomerGroupsGroupParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-4.FindParams.md).[expand](internal-4.FindParams.md#expand) + +#### Defined in + +medusa/dist/types/common.d.ts:116 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-4.FindParams.md).[fields](internal-4.FindParams.md#fields) + +#### Defined in + +medusa/dist/types/common.d.ts:117 diff --git a/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsParams.md b/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsParams.md new file mode 100644 index 0000000000..2fb6d89848 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminGetCustomerGroupsParams.md @@ -0,0 +1,119 @@ +# Class: AdminGetCustomerGroupsParams + +[internal](../modules/internal-4.md).AdminGetCustomerGroupsParams + +## Hierarchy + +- [`FilterableCustomerGroupProps`](internal-4.FilterableCustomerGroupProps.md) + + ↳ **`AdminGetCustomerGroupsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[created_at](internal-4.FilterableCustomerGroupProps.md#created_at) + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:7 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:38 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[id](internal-4.FilterableCustomerGroupProps.md#id) + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:3 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:37 + +___ + +### name + +• `Optional` **name**: `string`[] + +#### Inherited from + +[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[name](internal-4.FilterableCustomerGroupProps.md#name) + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:5 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:36 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:35 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[q](internal-4.FilterableCustomerGroupProps.md#q) + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:4 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal-4.FilterableCustomerGroupProps.md).[updated_at](internal-4.FilterableCustomerGroupProps.md#updated_at) + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal-4.AdminGetCustomersParams.md b/docs/content/references/js-client/classes/internal-4.AdminGetCustomersParams.md new file mode 100644 index 0000000000..f4ad857990 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminGetCustomersParams.md @@ -0,0 +1,67 @@ +# Class: AdminGetCustomersParams + +[internal](../modules/internal-4.md).AdminGetCustomersParams + +## Hierarchy + +- [`AdminListCustomerSelector`](internal-4.AdminListCustomerSelector.md) + + ↳ **`AdminGetCustomersParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/list-customers.d.ts:25 + +___ + +### groups + +• `Optional` **groups**: `string`[] + +#### Inherited from + +[AdminListCustomerSelector](internal-4.AdminListCustomerSelector.md).[groups](internal-4.AdminListCustomerSelector.md#groups) + +#### Defined in + +medusa/dist/types/customers.d.ts:4 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/customers/list-customers.d.ts:23 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/customers/list-customers.d.ts:24 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[AdminListCustomerSelector](internal-4.AdminListCustomerSelector.md).[q](internal-4.AdminListCustomerSelector.md#q) + +#### Defined in + +medusa/dist/types/customers.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal-4.AdminListCustomerSelector.md b/docs/content/references/js-client/classes/internal-4.AdminListCustomerSelector.md new file mode 100644 index 0000000000..18e97714af --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminListCustomerSelector.md @@ -0,0 +1,29 @@ +# Class: AdminListCustomerSelector + +[internal](../modules/internal-4.md).AdminListCustomerSelector + +## Hierarchy + +- **`AdminListCustomerSelector`** + + ↳ [`AdminGetCustomersParams`](internal-4.AdminGetCustomersParams.md) + +## Properties + +### groups + +• `Optional` **groups**: `string`[] + +#### Defined in + +medusa/dist/types/customers.d.ts:4 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/types/customers.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md b/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md new file mode 100644 index 0000000000..4518fe2882 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md @@ -0,0 +1,13 @@ +# Class: AdminPostCustomerGroupsGroupCustomersBatchReq + +[internal](../modules/internal-4.md).AdminPostCustomerGroupsGroupCustomersBatchReq + +## Properties + +### customer\_ids + +• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-4.CustomerGroupsBatchCustomer.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupReq.md b/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupReq.md new file mode 100644 index 0000000000..54d3a47e2f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsGroupReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostCustomerGroupsGroupReq + +[internal](../modules/internal-4.md).AdminPostCustomerGroupsGroupReq + +## Properties + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:28 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsReq.md b/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsReq.md new file mode 100644 index 0000000000..ba70fdcfaf --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.AdminPostCustomerGroupsReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostCustomerGroupsReq + +[internal](../modules/internal-4.md).AdminPostCustomerGroupsReq + +## Properties + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:27 + +___ + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal-4.CustomerGroupsBatchCustomer.md b/docs/content/references/js-client/classes/internal-4.CustomerGroupsBatchCustomer.md new file mode 100644 index 0000000000..9271db5c44 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.CustomerGroupsBatchCustomer.md @@ -0,0 +1,13 @@ +# Class: CustomerGroupsBatchCustomer + +[internal](../modules/internal-4.md).CustomerGroupsBatchCustomer + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:10 diff --git a/docs/content/references/js-client/classes/internal-4.FilterableCustomerGroupProps.md b/docs/content/references/js-client/classes/internal-4.FilterableCustomerGroupProps.md new file mode 100644 index 0000000000..3c79b179bf --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.FilterableCustomerGroupProps.md @@ -0,0 +1,59 @@ +# Class: FilterableCustomerGroupProps + +[internal](../modules/internal-4.md).FilterableCustomerGroupProps + +## Hierarchy + +- **`FilterableCustomerGroupProps`** + + ↳ [`AdminGetCustomerGroupsParams`](internal-4.AdminGetCustomerGroupsParams.md) + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:7 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-4.StringComparisonOperator.md) + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:3 + +___ + +### name + +• `Optional` **name**: `string`[] + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:5 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:4 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +medusa/dist/types/customer-groups.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal-4.FindParams.md b/docs/content/references/js-client/classes/internal-4.FindParams.md new file mode 100644 index 0000000000..14a5b60563 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-4.FindParams.md @@ -0,0 +1,29 @@ +# Class: FindParams + +[internal](../modules/internal-4.md).FindParams + +## Hierarchy + +- **`FindParams`** + + ↳ [`AdminGetCustomerGroupsGroupParams`](internal-4.AdminGetCustomerGroupsGroupParams.md) + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/types/common.d.ts:116 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +medusa/dist/types/common.d.ts:117 diff --git a/docs/content/references/js-client/classes/internal.StringComparisonOperator.md b/docs/content/references/js-client/classes/internal-4.StringComparisonOperator.md similarity index 52% rename from docs/content/references/js-client/classes/internal.StringComparisonOperator.md rename to docs/content/references/js-client/classes/internal-4.StringComparisonOperator.md index a6d01a398a..cf2a8d1503 100644 --- a/docs/content/references/js-client/classes/internal.StringComparisonOperator.md +++ b/docs/content/references/js-client/classes/internal-4.StringComparisonOperator.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: StringComparisonOperator -[internal](../modules/internal.md).StringComparisonOperator +[internal](../modules/internal-4.md).StringComparisonOperator ## Properties @@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/common.d.ts:52 +medusa/dist/types/common.d.ts:79 ___ @@ -24,7 +20,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:53 +medusa/dist/types/common.d.ts:80 ___ @@ -34,7 +30,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:51 +medusa/dist/types/common.d.ts:78 ___ @@ -44,4 +40,4 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:54 +medusa/dist/types/common.d.ts:81 diff --git a/docs/content/references/js-client/classes/internal-41.Item.md b/docs/content/references/js-client/classes/internal-41.Item.md new file mode 100644 index 0000000000..e3c9ddff5e --- /dev/null +++ b/docs/content/references/js-client/classes/internal-41.Item.md @@ -0,0 +1,43 @@ +# Class: Item + +[internal](../modules/internal-41.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:58 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:61 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:59 + +___ + +### reason\_id + +• `Optional` **reason\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:60 diff --git a/docs/content/references/js-client/classes/internal-41.ReturnShipping.md b/docs/content/references/js-client/classes/internal-41.ReturnShipping.md new file mode 100644 index 0000000000..f397ebaea5 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-41.ReturnShipping.md @@ -0,0 +1,13 @@ +# Class: ReturnShipping + +[internal](../modules/internal-41.md).ReturnShipping + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:55 diff --git a/docs/content/references/js-client/classes/internal-41.StorePostReturnsReq.md b/docs/content/references/js-client/classes/internal-41.StorePostReturnsReq.md new file mode 100644 index 0000000000..7256c7b064 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-41.StorePostReturnsReq.md @@ -0,0 +1,33 @@ +# Class: StorePostReturnsReq + +[internal](../modules/internal-41.md).StorePostReturnsReq + +## Properties + +### items + +• **items**: [`Item`](internal-41.Item.md)[] + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:65 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:64 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-41.ReturnShipping.md) + +#### Defined in + +medusa/dist/api/routes/store/returns/create-return.d.ts:66 diff --git a/docs/content/references/js-client/classes/internal-42.StoreGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal-42.StoreGetShippingOptionsParams.md new file mode 100644 index 0000000000..7b00fd5297 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-42.StoreGetShippingOptionsParams.md @@ -0,0 +1,33 @@ +# Class: StoreGetShippingOptionsParams + +[internal](../modules/internal-42.md).StoreGetShippingOptionsParams + +## Properties + +### is\_return + +• `Optional` **is\_return**: `string` + +#### Defined in + +medusa/dist/api/routes/store/shipping-options/list-options.d.ts:29 + +___ + +### product\_ids + +• `Optional` **product\_ids**: `string` + +#### Defined in + +medusa/dist/api/routes/store/shipping-options/list-options.d.ts:27 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/shipping-options/list-options.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal-43.AdditionalItem.md b/docs/content/references/js-client/classes/internal-43.AdditionalItem.md new file mode 100644 index 0000000000..b86e8cc4dd --- /dev/null +++ b/docs/content/references/js-client/classes/internal-43.AdditionalItem.md @@ -0,0 +1,23 @@ +# Class: AdditionalItem + +[internal](../modules/internal-43.md).AdditionalItem + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:81 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:80 diff --git a/docs/content/references/js-client/classes/internal-43.Item.md b/docs/content/references/js-client/classes/internal-43.Item.md new file mode 100644 index 0000000000..83c31feb0c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-43.Item.md @@ -0,0 +1,43 @@ +# Class: Item + +[internal](../modules/internal-43.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:74 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:77 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:75 + +___ + +### reason\_id + +• `Optional` **reason\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:76 diff --git a/docs/content/references/js-client/classes/internal-43.StorePostSwapsReq.md b/docs/content/references/js-client/classes/internal-43.StorePostSwapsReq.md new file mode 100644 index 0000000000..eeed53569f --- /dev/null +++ b/docs/content/references/js-client/classes/internal-43.StorePostSwapsReq.md @@ -0,0 +1,43 @@ +# Class: StorePostSwapsReq + +[internal](../modules/internal-43.md).StorePostSwapsReq + +## Properties + +### additional\_items + +• **additional\_items**: [`AdditionalItem`](internal-43.AdditionalItem.md)[] + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:86 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:84 + +___ + +### return\_items + +• **return\_items**: [`Item`](internal-43.Item.md)[] + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:85 + +___ + +### return\_shipping\_option + +• `Optional` **return\_shipping\_option**: `string` + +#### Defined in + +medusa/dist/api/routes/store/swaps/create-swap.d.ts:87 diff --git a/docs/content/references/js-client/classes/internal-5.AdminPostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal-5.AdminPostCustomersCustomerReq.md new file mode 100644 index 0000000000..615b004beb --- /dev/null +++ b/docs/content/references/js-client/classes/internal-5.AdminPostCustomersCustomerReq.md @@ -0,0 +1,73 @@ +# Class: AdminPostCustomersCustomerReq + +[internal](../modules/internal-5.md).AdminPostCustomersCustomerReq + +## Properties + +### email + +• `Optional` **email**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:60 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:61 + +___ + +### groups + +• `Optional` **groups**: [`Group`](internal-5.Group.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:66 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:62 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:65 + +___ + +### password + +• `Optional` **password**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:63 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:64 diff --git a/docs/content/references/js-client/classes/internal-5.AdminPostCustomersReq.md b/docs/content/references/js-client/classes/internal-5.AdminPostCustomersReq.md new file mode 100644 index 0000000000..ec85320dac --- /dev/null +++ b/docs/content/references/js-client/classes/internal-5.AdminPostCustomersReq.md @@ -0,0 +1,63 @@ +# Class: AdminPostCustomersReq + +[internal](../modules/internal-5.md).AdminPostCustomersReq + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/create-customer.d.ts:28 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/create-customer.d.ts:29 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/create-customer.d.ts:30 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/customers/create-customer.d.ts:33 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/create-customer.d.ts:31 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/create-customer.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal-5.Group.md b/docs/content/references/js-client/classes/internal-5.Group.md new file mode 100644 index 0000000000..921fb97bff --- /dev/null +++ b/docs/content/references/js-client/classes/internal-5.Group.md @@ -0,0 +1,13 @@ +# Class: Group + +[internal](../modules/internal-5.md).Group + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/customers/update-customer.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal-6.AdminCreateCondition.md b/docs/content/references/js-client/classes/internal-6.AdminCreateCondition.md new file mode 100644 index 0000000000..d108217a42 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminCreateCondition.md @@ -0,0 +1,89 @@ +# Class: AdminCreateCondition + +[internal](../modules/internal-6.md).AdminCreateCondition + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal-6.AdminUpsertConditionsReq.md) + + ↳ **`AdminCreateCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[customer_groups](internal-6.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +medusa/dist/types/discount.d.ts:22 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:83 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_collections](internal-6.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +medusa/dist/types/discount.d.ts:19 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_tags](internal-6.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +medusa/dist/types/discount.d.ts:21 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_types](internal-6.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +medusa/dist/types/discount.d.ts:20 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[products](internal-6.AdminUpsertConditionsReq.md#products) + +#### Defined in + +medusa/dist/types/discount.d.ts:18 diff --git a/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md b/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md new file mode 100644 index 0000000000..69cc7c9111 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md @@ -0,0 +1,23 @@ +# Class: AdminGetDiscountsDiscountConditionsConditionParams + +[internal](../modules/internal-6.md).AdminGetDiscountsDiscountConditionsConditionParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/get-condition.d.ts:29 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/get-condition.d.ts:30 diff --git a/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountRuleParams.md b/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountRuleParams.md similarity index 59% rename from docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountRuleParams.md rename to docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountRuleParams.md index e9fbe7a2ec..977fc42444 100644 --- a/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountRuleParams.md +++ b/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsDiscountRuleParams.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: AdminGetDiscountsDiscountRuleParams -[internal](../modules/internal.md).AdminGetDiscountsDiscountRuleParams +[internal](../modules/internal-6.md).AdminGetDiscountsDiscountRuleParams ## Properties @@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/discount.d.ts:14 +medusa/dist/types/discount.d.ts:15 ___ @@ -24,4 +20,4 @@ ___ #### Defined in -packages/medusa/dist/types/discount.d.ts:13 +medusa/dist/types/discount.d.ts:14 diff --git a/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsParams.md b/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsParams.md new file mode 100644 index 0000000000..3c4ffb1a61 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminGetDiscountsParams.md @@ -0,0 +1,73 @@ +# Class: AdminGetDiscountsParams + +[internal](../modules/internal-6.md).AdminGetDiscountsParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:36 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:33 + +___ + +### is\_dynamic + +• `Optional` **is\_dynamic**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:32 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:34 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:35 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:31 + +___ + +### rule + +• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal-6.AdminGetDiscountsDiscountRuleParams.md) + +#### Defined in + +medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:30 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditions.md b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditions.md new file mode 100644 index 0000000000..96f78e0f18 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditions.md @@ -0,0 +1,89 @@ +# Class: AdminPostDiscountsDiscountConditions + +[internal](../modules/internal-6.md).AdminPostDiscountsDiscountConditions + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal-6.AdminUpsertConditionsReq.md) + + ↳ **`AdminPostDiscountsDiscountConditions`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[customer_groups](internal-6.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +medusa/dist/types/discount.d.ts:22 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-condition.d.ts:53 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_collections](internal-6.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +medusa/dist/types/discount.d.ts:19 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_tags](internal-6.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +medusa/dist/types/discount.d.ts:21 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_types](internal-6.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +medusa/dist/types/discount.d.ts:20 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[products](internal-6.AdminUpsertConditionsReq.md#products) + +#### Defined in + +medusa/dist/types/discount.d.ts:18 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md new file mode 100644 index 0000000000..23ee1c751d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md @@ -0,0 +1,79 @@ +# Class: AdminPostDiscountsDiscountConditionsCondition + +[internal](../modules/internal-6.md).AdminPostDiscountsDiscountConditionsCondition + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal-6.AdminUpsertConditionsReq.md) + + ↳ **`AdminPostDiscountsDiscountConditionsCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[customer_groups](internal-6.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +medusa/dist/types/discount.d.ts:22 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_collections](internal-6.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +medusa/dist/types/discount.d.ts:19 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_tags](internal-6.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +medusa/dist/types/discount.d.ts:21 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_types](internal-6.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +medusa/dist/types/discount.d.ts:20 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[products](internal-6.AdminUpsertConditionsReq.md#products) + +#### Defined in + +medusa/dist/types/discount.d.ts:18 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md new file mode 100644 index 0000000000..1ce7e2642b --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md @@ -0,0 +1,23 @@ +# Class: AdminPostDiscountsDiscountConditionsConditionParams + +[internal](../modules/internal-6.md).AdminPostDiscountsDiscountConditionsConditionParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-condition.d.ts:53 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-condition.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md new file mode 100644 index 0000000000..589dfe348c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md @@ -0,0 +1,23 @@ +# Class: AdminPostDiscountsDiscountConditionsParams + +[internal](../modules/internal-6.md).AdminPostDiscountsDiscountConditionsParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-condition.d.ts:56 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-condition.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md new file mode 100644 index 0000000000..0bf7848a95 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostDiscountsDiscountDynamicCodesReq + +[internal](../modules/internal-6.md).AdminPostDiscountsDiscountDynamicCodesReq + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:27 + +___ + +### metadata + +• `Optional` **metadata**: `object` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:29 + +___ + +### usage\_limit + +• **usage\_limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountReq.md b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountReq.md new file mode 100644 index 0000000000..a6b7827498 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountReq.md @@ -0,0 +1,93 @@ +# Class: AdminPostDiscountsDiscountReq + +[internal](../modules/internal-6.md).AdminPostDiscountsDiscountReq + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:56 + +___ + +### ends\_at + +• `Optional` **ends\_at**: ``null`` \| `Date` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:60 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:58 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:64 + +___ + +### regions + +• `Optional` **regions**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:63 + +___ + +### rule + +• `Optional` **rule**: [`AdminUpdateDiscountRule`](internal-6.AdminUpdateDiscountRule.md) + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:57 + +___ + +### starts\_at + +• `Optional` **starts\_at**: `Date` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:59 + +___ + +### usage\_limit + +• `Optional` **usage\_limit**: ``null`` \| `number` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:62 + +___ + +### valid\_duration + +• `Optional` **valid\_duration**: ``null`` \| `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountRule.md b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountRule.md similarity index 51% rename from docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountRule.md rename to docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountRule.md index 82f14dafb8..211b8fa5e8 100644 --- a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountRule.md +++ b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsDiscountRule.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: AdminPostDiscountsDiscountRule -[internal](../modules/internal.md).AdminPostDiscountsDiscountRule +[internal](../modules/internal-6.md).AdminPostDiscountsDiscountRule ## Properties @@ -14,17 +10,17 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:80 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:79 ___ ### conditions -• `Optional` **conditions**: [`AdminCreateCondition`](internal.AdminCreateCondition.md)[] +• `Optional` **conditions**: [`AdminCreateCondition`](internal-6.AdminCreateCondition.md)[] #### Defined in -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:81 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:80 ___ @@ -34,7 +30,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:77 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:76 ___ @@ -44,7 +40,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:78 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:77 ___ @@ -54,4 +50,4 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:79 +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:78 diff --git a/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsReq.md b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsReq.md new file mode 100644 index 0000000000..7f13d92fd1 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminPostDiscountsReq.md @@ -0,0 +1,103 @@ +# Class: AdminPostDiscountsReq + +[internal](../modules/internal-6.md).AdminPostDiscountsReq + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:64 + +___ + +### ends\_at + +• `Optional` **ends\_at**: `Date` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:69 + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:67 + +___ + +### is\_dynamic + +• **is\_dynamic**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:66 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:73 + +___ + +### regions + +• `Optional` **regions**: `string`[] + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:72 + +___ + +### rule + +• **rule**: [`AdminPostDiscountsDiscountRule`](internal-6.AdminPostDiscountsDiscountRule.md) + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:65 + +___ + +### starts\_at + +• `Optional` **starts\_at**: `Date` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:68 + +___ + +### usage\_limit + +• `Optional` **usage\_limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:71 + +___ + +### valid\_duration + +• `Optional` **valid\_duration**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/create-discount.d.ts:70 diff --git a/docs/content/references/js-client/classes/internal-6.AdminUpdateDiscountRule.md b/docs/content/references/js-client/classes/internal-6.AdminUpdateDiscountRule.md new file mode 100644 index 0000000000..0d8ae2876c --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminUpdateDiscountRule.md @@ -0,0 +1,53 @@ +# Class: AdminUpdateDiscountRule + +[internal](../modules/internal-6.md).AdminUpdateDiscountRule + +## Properties + +### allocation + +• `Optional` **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:70 + +___ + +### conditions + +• `Optional` **conditions**: [`AdminUpsertCondition`](internal-6.AdminUpsertCondition.md)[] + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:71 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:68 + +___ + +### id + +• **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:67 + +___ + +### value + +• `Optional` **value**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:69 diff --git a/docs/content/references/js-client/classes/internal-6.AdminUpsertCondition.md b/docs/content/references/js-client/classes/internal-6.AdminUpsertCondition.md new file mode 100644 index 0000000000..9bd4d4e6ed --- /dev/null +++ b/docs/content/references/js-client/classes/internal-6.AdminUpsertCondition.md @@ -0,0 +1,99 @@ +# Class: AdminUpsertCondition + +[internal](../modules/internal-6.md).AdminUpsertCondition + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal-6.AdminUpsertConditionsReq.md) + + ↳ **`AdminUpsertCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[customer_groups](internal-6.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +medusa/dist/types/discount.d.ts:22 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:74 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) + +#### Defined in + +medusa/dist/api/routes/admin/discounts/update-discount.d.ts:75 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_collections](internal-6.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +medusa/dist/types/discount.d.ts:19 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_tags](internal-6.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +medusa/dist/types/discount.d.ts:21 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[product_types](internal-6.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +medusa/dist/types/discount.d.ts:20 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-6.AdminUpsertConditionsReq.md).[products](internal-6.AdminUpsertConditionsReq.md#products) + +#### Defined in + +medusa/dist/types/discount.d.ts:18 diff --git a/docs/content/references/js-client/classes/internal.AdminUpsertConditionsReq.md b/docs/content/references/js-client/classes/internal-6.AdminUpsertConditionsReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal.AdminUpsertConditionsReq.md rename to docs/content/references/js-client/classes/internal-6.AdminUpsertConditionsReq.md index 8a1b5a7be4..a91da024be 100644 --- a/docs/content/references/js-client/classes/internal.AdminUpsertConditionsReq.md +++ b/docs/content/references/js-client/classes/internal-6.AdminUpsertConditionsReq.md @@ -1,22 +1,18 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: AdminUpsertConditionsReq -[internal](../modules/internal.md).AdminUpsertConditionsReq +[internal](../modules/internal-6.md).AdminUpsertConditionsReq ## Hierarchy - **`AdminUpsertConditionsReq`** - ↳ [`AdminPostDiscountsDiscountConditions`](internal.AdminPostDiscountsDiscountConditions.md) + ↳ [`AdminPostDiscountsDiscountConditions`](internal-6.AdminPostDiscountsDiscountConditions.md) - ↳ [`AdminPostDiscountsDiscountConditionsCondition`](internal.AdminPostDiscountsDiscountConditionsCondition.md) + ↳ [`AdminPostDiscountsDiscountConditionsCondition`](internal-6.AdminPostDiscountsDiscountConditionsCondition.md) - ↳ [`AdminCreateCondition`](internal.AdminCreateCondition.md) + ↳ [`AdminCreateCondition`](internal-6.AdminCreateCondition.md) - ↳ [`AdminUpsertCondition`](internal.AdminUpsertCondition.md) + ↳ [`AdminUpsertCondition`](internal-6.AdminUpsertCondition.md) ## Properties @@ -26,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/discount.d.ts:21 +medusa/dist/types/discount.d.ts:22 ___ @@ -36,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/types/discount.d.ts:18 +medusa/dist/types/discount.d.ts:19 ___ @@ -46,7 +42,7 @@ ___ #### Defined in -packages/medusa/dist/types/discount.d.ts:20 +medusa/dist/types/discount.d.ts:21 ___ @@ -56,7 +52,7 @@ ___ #### Defined in -packages/medusa/dist/types/discount.d.ts:19 +medusa/dist/types/discount.d.ts:20 ___ @@ -66,4 +62,4 @@ ___ #### Defined in -packages/medusa/dist/types/discount.d.ts:17 +medusa/dist/types/discount.d.ts:18 diff --git a/docs/content/references/js-client/classes/internal-7.AdminGetDraftOrdersParams.md b/docs/content/references/js-client/classes/internal-7.AdminGetDraftOrdersParams.md new file mode 100644 index 0000000000..ee6d3b9b1d --- /dev/null +++ b/docs/content/references/js-client/classes/internal-7.AdminGetDraftOrdersParams.md @@ -0,0 +1,33 @@ +# Class: AdminGetDraftOrdersParams + +[internal](../modules/internal-7.md).AdminGetDraftOrdersParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:23 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:24 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:22 diff --git a/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md b/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md new file mode 100644 index 0000000000..46a3286803 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md @@ -0,0 +1,43 @@ +# Class: AdminPostDraftOrdersDraftOrderLineItemsItemReq + +[internal](../modules/internal-7.md).AdminPostDraftOrdersDraftOrderLineItemsItemReq + +## Properties + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:42 + +___ + +### quantity + +• `Optional` **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:41 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:39 + +___ + +### unit\_price + +• `Optional` **unit\_price**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:40 diff --git a/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md b/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md new file mode 100644 index 0000000000..75bac6d9f0 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md @@ -0,0 +1,53 @@ +# Class: AdminPostDraftOrdersDraftOrderLineItemsReq + +[internal](../modules/internal-7.md).AdminPostDraftOrdersDraftOrderLineItemsReq + +## Properties + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:48 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:47 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:44 + +___ + +### unit\_price + +• `Optional` **unit\_price**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:45 + +___ + +### variant\_id + +• `Optional` **variant\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:46 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderReq.md b/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md similarity index 50% rename from docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderReq.md rename to docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md index 5d463d6186..533f66d4aa 100644 --- a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderReq.md +++ b/docs/content/references/js-client/classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md @@ -1,10 +1,6 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: AdminPostDraftOrdersDraftOrderReq -[internal](../modules/internal.md).AdminPostDraftOrdersDraftOrderReq +[internal](../modules/internal-7.md).AdminPostDraftOrdersDraftOrderReq ## Properties @@ -14,7 +10,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:61 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:61 ___ @@ -24,7 +20,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:59 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:59 ___ @@ -34,17 +30,17 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:64 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:64 ___ ### discounts -• `Optional` **discounts**: `Discount`[] +• `Optional` **discounts**: [`Discount`](internal-7.Discount.md)[] #### Defined in -packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:63 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:63 ___ @@ -54,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:60 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:60 ___ @@ -64,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:65 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:65 ___ @@ -74,7 +70,7 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:58 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:58 ___ @@ -84,4 +80,4 @@ ___ #### Defined in -packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:62 +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:62 diff --git a/docs/content/references/js-client/classes/internal-7.Discount.md b/docs/content/references/js-client/classes/internal-7.Discount.md new file mode 100644 index 0000000000..ad487be8f3 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-7.Discount.md @@ -0,0 +1,13 @@ +# Class: Discount + +[internal](../modules/internal-7.md).Discount + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal-8.AdminGetGiftCardsParams.md b/docs/content/references/js-client/classes/internal-8.AdminGetGiftCardsParams.md new file mode 100644 index 0000000000..e2998989c7 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-8.AdminGetGiftCardsParams.md @@ -0,0 +1,33 @@ +# Class: AdminGetGiftCardsParams + +[internal](../modules/internal-8.md).AdminGetGiftCardsParams + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:24 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:25 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsGiftCardReq.md b/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsGiftCardReq.md new file mode 100644 index 0000000000..6fb440ac65 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsGiftCardReq.md @@ -0,0 +1,53 @@ +# Class: AdminPostGiftCardsGiftCardReq + +[internal](../modules/internal-8.md).AdminPostGiftCardsGiftCardReq + +## Properties + +### balance + +• `Optional` **balance**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:47 + +___ + +### ends\_at + +• `Optional` **ends\_at**: `Date` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:49 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:48 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:51 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:50 diff --git a/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsReq.md b/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsReq.md new file mode 100644 index 0000000000..a107ffca26 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-8.AdminPostGiftCardsReq.md @@ -0,0 +1,53 @@ +# Class: AdminPostGiftCardsReq + +[internal](../modules/internal-8.md).AdminPostGiftCardsReq + +## Properties + +### ends\_at + +• `Optional` **ends\_at**: `Date` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:46 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:47 + +___ + +### metadata + +• `Optional` **metadata**: `Record`<`string`, `unknown`\> + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:49 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:48 + +___ + +### value + +• `Optional` **value**: `number` + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptReq.md b/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptReq.md new file mode 100644 index 0000000000..1491114ccd --- /dev/null +++ b/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostInvitesInviteAcceptReq + +[internal](../modules/internal-9.md).AdminPostInvitesInviteAcceptReq + +## Properties + +### token + +• **token**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:48 + +___ + +### user + +• **user**: [`AdminPostInvitesInviteAcceptUserReq`](internal-9.AdminPostInvitesInviteAcceptUserReq.md) + +#### Defined in + +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md b/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md new file mode 100644 index 0000000000..3afffd8873 --- /dev/null +++ b/docs/content/references/js-client/classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md @@ -0,0 +1,33 @@ +# Class: AdminPostInvitesInviteAcceptUserReq + +[internal](../modules/internal-9.md).AdminPostInvitesInviteAcceptUserReq + +## Properties + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:43 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:44 + +___ + +### password + +• **password**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/invites/accept-invite.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal-9.AdminPostInvitesReq.md b/docs/content/references/js-client/classes/internal-9.AdminPostInvitesReq.md new file mode 100644 index 0000000000..6e79e1b5ab --- /dev/null +++ b/docs/content/references/js-client/classes/internal-9.AdminPostInvitesReq.md @@ -0,0 +1,23 @@ +# Class: AdminPostInvitesReq + +[internal](../modules/internal-9.md).AdminPostInvitesReq + +## Properties + +### role + +• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +medusa/dist/api/routes/admin/invites/create-invite.d.ts:32 + +___ + +### user + +• **user**: `string` + +#### Defined in + +medusa/dist/api/routes/admin/invites/create-invite.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.Invite.md b/docs/content/references/js-client/classes/internal-9.Invite.md similarity index 54% rename from docs/content/references/js-client/classes/internal.Invite.md rename to docs/content/references/js-client/classes/internal-9.Invite.md index a3148ece06..491717e1ed 100644 --- a/docs/content/references/js-client/classes/internal.Invite.md +++ b/docs/content/references/js-client/classes/internal-9.Invite.md @@ -1,10 +1,8 @@ ---- -displayed_sidebar: jsClientSidebar ---- - # Class: Invite -[internal](../modules/internal.md).Invite +[internal](../modules/internal-9.md).Invite + +Base abstract entity for all entities ## Hierarchy @@ -20,7 +18,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/invite.d.ts:6 +medusa/dist/models/invite.d.ts:6 ___ @@ -30,13 +28,13 @@ ___ #### Defined in -packages/medusa/dist/models/invite.d.ts:10 +medusa/dist/models/invite.d.ts:10 ___ ### 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,17 +56,17 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ ### expires\_at -• **expires\_at**: [`Date`](../modules/internal.md#date) +• **expires\_at**: `Date` #### Defined in -packages/medusa/dist/models/invite.d.ts:8 +medusa/dist/models/invite.d.ts:8 ___ @@ -82,27 +80,27 @@ ___ #### 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/invite.d.ts:9 +medusa/dist/models/invite.d.ts:9 ___ ### role -• **role**: [`UserRoles`](../enums/internal.UserRoles.md) +• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) #### Defined in -packages/medusa/dist/models/invite.d.ts:5 +medusa/dist/models/invite.d.ts:5 ___ @@ -112,13 +110,13 @@ ___ #### Defined in -packages/medusa/dist/models/invite.d.ts:7 +medusa/dist/models/invite.d.ts:7 ___ ### 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/invite.d.ts:4 +medusa/dist/models/invite.d.ts:4 diff --git a/docs/content/references/js-client/classes/internal.AdditionalItem.md b/docs/content/references/js-client/classes/internal.AdditionalItem.md deleted file mode 100644 index 527eb5e70e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdditionalItem.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdditionalItem - -[internal](../modules/internal.md).AdditionalItem - -## Properties - -### quantity - -• **quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:112 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:111 diff --git a/docs/content/references/js-client/classes/internal.Address.md b/docs/content/references/js-client/classes/internal.Address.md index 9d56fe244e..685184010b 100644 --- a/docs/content/references/js-client/classes/internal.Address.md +++ b/docs/content/references/js-client/classes/internal.Address.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Address +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/address.d.ts:37 +medusa/dist/models/address.d.ts:37 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:38 +medusa/dist/models/address.d.ts:38 ___ @@ -40,7 +42,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:46 +medusa/dist/models/address.d.ts:46 ___ @@ -50,7 +52,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:39 +medusa/dist/models/address.d.ts:39 ___ @@ -60,7 +62,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:34 +medusa/dist/models/address.d.ts:34 ___ @@ -70,7 +72,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:41 +medusa/dist/models/address.d.ts:41 ___ @@ -80,13 +82,13 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:40 +medusa/dist/models/address.d.ts:40 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -94,7 +96,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -104,7 +106,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:33 +medusa/dist/models/address.d.ts:33 ___ @@ -114,13 +116,13 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:32 +medusa/dist/models/address.d.ts:32 ___ ### deleted\_at -• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **deleted\_at**: ``null`` \| `Date` #### Inherited from @@ -128,7 +130,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -138,7 +140,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:35 +medusa/dist/models/address.d.ts:35 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -162,17 +164,17 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:36 +medusa/dist/models/address.d.ts:36 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/address.d.ts:45 +medusa/dist/models/address.d.ts:45 ___ @@ -182,7 +184,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:44 +medusa/dist/models/address.d.ts:44 ___ @@ -192,7 +194,7 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:43 +medusa/dist/models/address.d.ts:43 ___ @@ -202,13 +204,13 @@ ___ #### Defined in -packages/medusa/dist/models/address.d.ts:42 +medusa/dist/models/address.d.ts:42 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -216,4 +218,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.AddressCreatePayload.md b/docs/content/references/js-client/classes/internal.AddressCreatePayload.md index 42224a0810..4ca897cbeb 100644 --- a/docs/content/references/js-client/classes/internal.AddressCreatePayload.md +++ b/docs/content/references/js-client/classes/internal.AddressCreatePayload.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/common.d.ts:81 +medusa/dist/types/common.d.ts:108 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:82 +medusa/dist/types/common.d.ts:109 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:83 +medusa/dist/types/common.d.ts:110 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:80 +medusa/dist/types/common.d.ts:107 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:84 +medusa/dist/types/common.d.ts:111 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:76 +medusa/dist/types/common.d.ts:103 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:77 +medusa/dist/types/common.d.ts:104 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:79 +medusa/dist/types/common.d.ts:106 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:78 +medusa/dist/types/common.d.ts:105 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:86 +medusa/dist/types/common.d.ts:113 ___ @@ -114,4 +114,4 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:85 +medusa/dist/types/common.d.ts:112 diff --git a/docs/content/references/js-client/classes/internal.AddressPayload.md b/docs/content/references/js-client/classes/internal.AddressPayload.md index 62ba20c3df..3592a179ba 100644 --- a/docs/content/references/js-client/classes/internal.AddressPayload.md +++ b/docs/content/references/js-client/classes/internal.AddressPayload.md @@ -20,7 +20,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/common.d.ts:68 +medusa/dist/types/common.d.ts:95 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:69 +medusa/dist/types/common.d.ts:96 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:70 +medusa/dist/types/common.d.ts:97 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:67 +medusa/dist/types/common.d.ts:94 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:71 +medusa/dist/types/common.d.ts:98 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:63 +medusa/dist/types/common.d.ts:90 ___ @@ -80,17 +80,17 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:64 +medusa/dist/types/common.d.ts:91 ___ ### metadata -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/types/common.d.ts:66 +medusa/dist/types/common.d.ts:93 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:65 +medusa/dist/types/common.d.ts:92 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:73 +medusa/dist/types/common.d.ts:100 ___ @@ -120,4 +120,4 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:72 +medusa/dist/types/common.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal.AdminCreateCondition.md b/docs/content/references/js-client/classes/internal.AdminCreateCondition.md deleted file mode 100644 index 4193e7e782..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminCreateCondition.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminCreateCondition - -[internal](../modules/internal.md).AdminCreateCondition - -## Hierarchy - -- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md) - - ↳ **`AdminCreateCondition`** - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:21 - -___ - -### operator - -• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:84 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:18 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:20 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:19 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.AdminCreateUserRequest.md b/docs/content/references/js-client/classes/internal.AdminCreateUserRequest.md deleted file mode 100644 index d315df61eb..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminCreateUserRequest.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminCreateUserRequest - -[internal](../modules/internal.md).AdminCreateUserRequest - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/create-user.d.ts:46 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/create-user.d.ts:47 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/create-user.d.ts:48 - -___ - -### password - -• **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/create-user.d.ts:50 - -___ - -### role - -• `Optional` **role**: [`UserRoles`](../enums/internal.UserRoles.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/create-user.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md b/docs/content/references/js-client/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md deleted file mode 100644 index 7bb60ef0f9..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDeleteCustomerGroupsGroupCustomerBatchReq - -[internal](../modules/internal.md).AdminDeleteCustomerGroupsGroupCustomerBatchReq - -## Properties - -### customer\_ids - -• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal.CustomerGroupsBatchCustomer.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminDeletePriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal.AdminDeletePriceListPricesPricesReq.md deleted file mode 100644 index d7e0d89aa5..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminDeletePriceListPricesPricesReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDeletePriceListPricesPricesReq - -[internal](../modules/internal.md).AdminDeletePriceListPricesPricesReq - -## Properties - -### price\_ids - -• **price\_ids**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts:42 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md deleted file mode 100644 index 8cba611caa..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDeleteTaxRatesTaxRateProductTypesParams - -[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductTypesParams - -## Properties - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:27 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md deleted file mode 100644 index 8fd82602f6..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDeleteTaxRatesTaxRateProductTypesReq - -[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductTypesReq - -## Properties - -### product\_types - -• **product\_types**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.md deleted file mode 100644 index efa10034a1..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDeleteTaxRatesTaxRateProductsParams - -[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductsParams - -## Properties - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:27 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.md deleted file mode 100644 index 6d0fa1e1b3..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDeleteTaxRatesTaxRateProductsReq - -[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductsReq - -## Properties - -### products - -• **products**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md deleted file mode 100644 index 6bace3d9db..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDeleteTaxRatesTaxRateShippingOptionsParams - -[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams - -## Properties - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:27 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md deleted file mode 100644 index c5dd5e7dea..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminDeleteTaxRatesTaxRateShippingOptionsReq - -[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq - -## Properties - -### shipping\_options - -• **shipping\_options**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCollectionsPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetCollectionsPaginationParams.md deleted file mode 100644 index 181f30beb5..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetCollectionsPaginationParams.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetCollectionsPaginationParams - -[internal](../modules/internal.md).AdminGetCollectionsPaginationParams - -## Hierarchy - -- **`AdminGetCollectionsPaginationParams`** - - ↳ [`AdminGetCollectionsParams`](internal.AdminGetCollectionsParams.md) - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:31 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCollectionsParams.md b/docs/content/references/js-client/classes/internal.AdminGetCollectionsParams.md deleted file mode 100644 index 216a88e9a3..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetCollectionsParams.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetCollectionsParams - -[internal](../modules/internal.md).AdminGetCollectionsParams - -## Hierarchy - -- [`AdminGetCollectionsPaginationParams`](internal.AdminGetCollectionsPaginationParams.md) - - ↳ **`AdminGetCollectionsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:37 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:39 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:36 - -___ - -### limit - -• **limit**: `number` - -#### Inherited from - -[AdminGetCollectionsPaginationParams](internal.AdminGetCollectionsPaginationParams.md).[limit](internal.AdminGetCollectionsPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:31 - -___ - -### offset - -• **offset**: `number` - -#### Inherited from - -[AdminGetCollectionsPaginationParams](internal.AdminGetCollectionsPaginationParams.md).[offset](internal.AdminGetCollectionsPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:32 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:40 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:35 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:38 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsGroupParams.md b/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsGroupParams.md deleted file mode 100644 index 50dc8c5429..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsGroupParams.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetCustomerGroupsGroupParams - -[internal](../modules/internal.md).AdminGetCustomerGroupsGroupParams - -## Hierarchy - -- [`FindParams`](internal.FindParams.md) - - ↳ **`AdminGetCustomerGroupsGroupParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[FindParams](internal.FindParams.md).[expand](internal.FindParams.md#expand) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:89 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[FindParams](internal.FindParams.md).[fields](internal.FindParams.md#fields) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:90 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsParams.md b/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsParams.md deleted file mode 100644 index 892fdefe9c..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsParams.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetCustomerGroupsParams - -[internal](../modules/internal.md).AdminGetCustomerGroupsParams - -## Hierarchy - -- [`FilterableCustomerGroupProps`](internal.FilterableCustomerGroupProps.md) - - ↳ **`AdminGetCustomerGroupsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Inherited from - -[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[created_at](internal.FilterableCustomerGroupProps.md#created_at) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:7 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:37 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) - -#### Inherited from - -[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[id](internal.FilterableCustomerGroupProps.md#id) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:3 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:36 - -___ - -### name - -• `Optional` **name**: `string`[] - -#### Inherited from - -[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[name](internal.FilterableCustomerGroupProps.md#name) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:5 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:35 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:34 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[q](internal.FilterableCustomerGroupProps.md#q) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:4 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Inherited from - -[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[updated_at](internal.FilterableCustomerGroupProps.md#updated_at) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal.AdminGetCustomersParams.md b/docs/content/references/js-client/classes/internal.AdminGetCustomersParams.md deleted file mode 100644 index 016924dadc..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetCustomersParams.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetCustomersParams - -[internal](../modules/internal.md).AdminGetCustomersParams - -## Hierarchy - -- [`AdminListCustomerSelector`](internal.AdminListCustomerSelector.md) - - ↳ **`AdminGetCustomersParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:25 - -___ - -### groups - -• `Optional` **groups**: `string`[] - -#### Inherited from - -[AdminListCustomerSelector](internal.AdminListCustomerSelector.md).[groups](internal.AdminListCustomerSelector.md#groups) - -#### Defined in - -packages/medusa/dist/types/customers.d.ts:3 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:23 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:24 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[AdminListCustomerSelector](internal.AdminListCustomerSelector.md).[q](internal.AdminListCustomerSelector.md#q) - -#### Defined in - -packages/medusa/dist/types/customers.d.ts:2 diff --git a/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.md b/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.md deleted file mode 100644 index 86a65fb0a8..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetDiscountsDiscountConditionsConditionParams - -[internal](../modules/internal.md).AdminGetDiscountsDiscountConditionsConditionParams - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/get-condition.d.ts:29 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/get-condition.d.ts:30 diff --git a/docs/content/references/js-client/classes/internal.AdminGetDiscountsParams.md b/docs/content/references/js-client/classes/internal.AdminGetDiscountsParams.md deleted file mode 100644 index 2dfe0e51ed..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetDiscountsParams.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetDiscountsParams - -[internal](../modules/internal.md).AdminGetDiscountsParams - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:36 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:33 - -___ - -### is\_dynamic - -• `Optional` **is\_dynamic**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:32 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:34 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:35 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:31 - -___ - -### rule - -• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal.AdminGetDiscountsDiscountRuleParams.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:30 diff --git a/docs/content/references/js-client/classes/internal.AdminGetDraftOrdersParams.md b/docs/content/references/js-client/classes/internal.AdminGetDraftOrdersParams.md deleted file mode 100644 index 8bd7aa753e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetDraftOrdersParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetDraftOrdersParams - -[internal](../modules/internal.md).AdminGetDraftOrdersParams - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:23 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:24 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:22 diff --git a/docs/content/references/js-client/classes/internal.AdminGetGiftCardsParams.md b/docs/content/references/js-client/classes/internal.AdminGetGiftCardsParams.md deleted file mode 100644 index 9082aebf3c..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetGiftCardsParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetGiftCardsParams - -[internal](../modules/internal.md).AdminGetGiftCardsParams - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:24 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:25 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminGetNotesParams.md b/docs/content/references/js-client/classes/internal.AdminGetNotesParams.md deleted file mode 100644 index dc8db3be32..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetNotesParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetNotesParams - -[internal](../modules/internal.md).AdminGetNotesParams - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:29 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:30 - -___ - -### resource\_id - -• `Optional` **resource\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminGetNotificationsParams.md b/docs/content/references/js-client/classes/internal.AdminGetNotificationsParams.md deleted file mode 100644 index a0c25d26d5..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetNotificationsParams.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetNotificationsParams - -[internal](../modules/internal.md).AdminGetNotificationsParams - -## Properties - -### event\_name - -• `Optional` **event\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:38 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:37 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:36 - -___ - -### include\_resends - -• `Optional` **include\_resends**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:42 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:34 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:35 - -___ - -### resource\_id - -• `Optional` **resource\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:40 - -___ - -### resource\_type - -• `Optional` **resource\_type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:39 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:41 diff --git a/docs/content/references/js-client/classes/internal.AdminGetOrdersParams.md b/docs/content/references/js-client/classes/internal.AdminGetOrdersParams.md deleted file mode 100644 index 3fdf1ed71e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetOrdersParams.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetOrdersParams - -[internal](../modules/internal.md).AdminGetOrdersParams - -## Hierarchy - -- [`AdminListOrdersSelector`](internal.AdminListOrdersSelector.md) - - ↳ **`AdminGetOrdersParams`** - -## Properties - -### canceled\_at - -• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[canceled_at](internal.AdminListOrdersSelector.md#canceled_at) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:17 - -___ - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[cart_id](internal.AdminListOrdersSelector.md#cart_id) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:11 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[created_at](internal.AdminListOrdersSelector.md#created_at) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:18 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[currency_code](internal.AdminListOrdersSelector.md#currency_code) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:15 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[customer_id](internal.AdminListOrdersSelector.md#customer_id) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:12 - -___ - -### display\_id - -• `Optional` **display\_id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[display_id](internal.AdminListOrdersSelector.md#display_id) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:10 - -___ - -### email - -• `Optional` **email**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[email](internal.AdminListOrdersSelector.md#email) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:13 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:47 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:48 - -___ - -### fulfillment\_status - -• `Optional` **fulfillment\_status**: `string`[] - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[fulfillment_status](internal.AdminListOrdersSelector.md#fulfillment_status) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:8 - -___ - -### id - -• `Optional` **id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[id](internal.AdminListOrdersSelector.md#id) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:6 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:46 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:45 - -___ - -### payment\_status - -• `Optional` **payment\_status**: `string`[] - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[payment_status](internal.AdminListOrdersSelector.md#payment_status) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:9 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[q](internal.AdminListOrdersSelector.md#q) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:5 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[region_id](internal.AdminListOrdersSelector.md#region_id) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:14 - -___ - -### status - -• `Optional` **status**: `string`[] - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[status](internal.AdminListOrdersSelector.md#status) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:7 - -___ - -### tax\_rate - -• `Optional` **tax\_rate**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[tax_rate](internal.AdminListOrdersSelector.md#tax_rate) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:16 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Inherited from - -[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[updated_at](internal.AdminListOrdersSelector.md#updated_at) - -#### Defined in - -packages/medusa/dist/types/orders.d.ts:19 diff --git a/docs/content/references/js-client/classes/internal.AdminGetPriceListPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetPriceListPaginationParams.md deleted file mode 100644 index 54ded2a905..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetPriceListPaginationParams.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetPriceListPaginationParams - -[internal](../modules/internal.md).AdminGetPriceListPaginationParams - -## Hierarchy - -- [`FilterablePriceListProps`](internal.FilterablePriceListProps.md) - - ↳ **`AdminGetPriceListPaginationParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[created_at](internal.FilterablePriceListProps.md#created_at) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:19 - -___ - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[customer_groups](internal.FilterablePriceListProps.md#customer_groups) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:16 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[deleted_at](internal.FilterablePriceListProps.md#deleted_at) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:21 - -___ - -### description - -• `Optional` **description**: `string` - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[description](internal.FilterablePriceListProps.md#description) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:17 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:36 - -___ - -### id - -• `Optional` **id**: `string` - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[id](internal.FilterablePriceListProps.md#id) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:12 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:35 - -___ - -### name - -• `Optional` **name**: `string` - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[name](internal.FilterablePriceListProps.md#name) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:15 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:34 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:37 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[q](internal.FilterablePriceListProps.md#q) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:13 - -___ - -### status - -• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md)[] - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[status](internal.FilterablePriceListProps.md#status) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:14 - -___ - -### type - -• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md)[] - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[type](internal.FilterablePriceListProps.md#type) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:18 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Inherited from - -[FilterablePriceListProps](internal.FilterablePriceListProps.md).[updated_at](internal.FilterablePriceListProps.md#updated_at) - -#### Defined in - -packages/medusa/dist/types/price-list.d.ts:20 diff --git a/docs/content/references/js-client/classes/internal.AdminGetPriceListsPriceListProductsParams.md b/docs/content/references/js-client/classes/internal.AdminGetPriceListsPriceListProductsParams.md deleted file mode 100644 index c1644a539d..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetPriceListsPriceListProductsParams.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetPriceListsPriceListProductsParams - -[internal](../modules/internal.md).AdminGetPriceListsPriceListProductsParams - -## Hierarchy - -- [`AdminGetProductsPaginationParams`](internal.AdminGetProductsPaginationParams.md) - - ↳ **`AdminGetPriceListsPriceListProductsParams`** - -## Properties - -### collection\_id - -• `Optional` **collection\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:63 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:71 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:73 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:66 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[expand](internal.AdminGetProductsPaginationParams.md#expand) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[fields](internal.AdminGetProductsPaginationParams.md#fields) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:67 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:60 - -___ - -### is\_giftcard - -• `Optional` **is\_giftcard**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:68 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[limit](internal.AdminGetProductsPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[offset](internal.AdminGetProductsPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:70 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:61 - -___ - -### status - -• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:62 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:64 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:65 - -___ - -### type - -• `Optional` **type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:69 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:72 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductTagsPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductTagsPaginationParams.md deleted file mode 100644 index 7a4c17aad9..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetProductTagsPaginationParams.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetProductTagsPaginationParams - -[internal](../modules/internal.md).AdminGetProductTagsPaginationParams - -## Hierarchy - -- **`AdminGetProductTagsPaginationParams`** - - ↳ [`AdminGetProductTagsParams`](internal.AdminGetProductTagsParams.md) - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:30 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductTagsParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductTagsParams.md deleted file mode 100644 index c0cc57bcce..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetProductTagsParams.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetProductTagsParams - -[internal](../modules/internal.md).AdminGetProductTagsParams - -## Hierarchy - -- [`AdminGetProductTagsPaginationParams`](internal.AdminGetProductTagsPaginationParams.md) - - ↳ **`AdminGetProductTagsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:37 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:34 - -___ - -### limit - -• **limit**: `number` - -#### Inherited from - -[AdminGetProductTagsPaginationParams](internal.AdminGetProductTagsPaginationParams.md).[limit](internal.AdminGetProductTagsPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:30 - -___ - -### offset - -• **offset**: `number` - -#### Inherited from - -[AdminGetProductTagsPaginationParams](internal.AdminGetProductTagsPaginationParams.md).[offset](internal.AdminGetProductTagsPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:31 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:39 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:35 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:38 - -___ - -### value - -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductTypesPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductTypesPaginationParams.md deleted file mode 100644 index a56d3fd558..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetProductTypesPaginationParams.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetProductTypesPaginationParams - -[internal](../modules/internal.md).AdminGetProductTypesPaginationParams - -## Hierarchy - -- **`AdminGetProductTypesPaginationParams`** - - ↳ [`AdminGetProductTypesParams`](internal.AdminGetProductTypesParams.md) - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:30 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductTypesParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductTypesParams.md deleted file mode 100644 index 14e110a16f..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetProductTypesParams.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetProductTypesParams - -[internal](../modules/internal.md).AdminGetProductTypesParams - -## Hierarchy - -- [`AdminGetProductTypesPaginationParams`](internal.AdminGetProductTypesPaginationParams.md) - - ↳ **`AdminGetProductTypesParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:37 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:34 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -[AdminGetProductTypesPaginationParams](internal.AdminGetProductTypesPaginationParams.md).[limit](internal.AdminGetProductTypesPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:30 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[AdminGetProductTypesPaginationParams](internal.AdminGetProductTypesPaginationParams.md).[offset](internal.AdminGetProductTypesPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:31 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:39 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:35 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:38 - -___ - -### value - -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductsPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductsPaginationParams.md deleted file mode 100644 index d61b91facf..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetProductsPaginationParams.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetProductsPaginationParams - -[internal](../modules/internal.md).AdminGetProductsPaginationParams - -## Hierarchy - -- **`AdminGetProductsPaginationParams`** - - ↳ [`AdminGetPriceListsPriceListProductsParams`](internal.AdminGetPriceListsPriceListProductsParams.md) - - ↳ [`AdminGetProductsParams`](internal.AdminGetProductsParams.md) - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59 diff --git a/docs/content/references/js-client/classes/internal.AdminGetProductsParams.md b/docs/content/references/js-client/classes/internal.AdminGetProductsParams.md deleted file mode 100644 index bc0ebc7cd5..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetProductsParams.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetProductsParams - -[internal](../modules/internal.md).AdminGetProductsParams - -## Hierarchy - -- [`AdminGetProductsPaginationParams`](internal.AdminGetProductsPaginationParams.md) - - ↳ **`AdminGetProductsParams`** - -## Properties - -### collection\_id - -• `Optional` **collection\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:68 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:77 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:79 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:72 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[expand](internal.AdminGetProductsPaginationParams.md#expand) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[fields](internal.AdminGetProductsPaginationParams.md#fields) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:73 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:65 - -___ - -### is\_giftcard - -• `Optional` **is\_giftcard**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:74 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[limit](internal.AdminGetProductsPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[offset](internal.AdminGetProductsPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:76 - -___ - -### price\_list\_id - -• `Optional` **price\_list\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:70 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:66 - -___ - -### status - -• `Optional` **status**: `ProductStatus`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:67 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:69 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:71 - -___ - -### type - -• `Optional` **type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:75 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/list-products.d.ts:78 diff --git a/docs/content/references/js-client/classes/internal.AdminGetRegionsPaginationParams.md b/docs/content/references/js-client/classes/internal.AdminGetRegionsPaginationParams.md deleted file mode 100644 index 032fa10ae0..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetRegionsPaginationParams.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetRegionsPaginationParams - -[internal](../modules/internal.md).AdminGetRegionsPaginationParams - -## Hierarchy - -- **`AdminGetRegionsPaginationParams`** - - ↳ [`AdminGetRegionsParams`](internal.AdminGetRegionsParams.md) - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:56 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal.AdminGetRegionsParams.md b/docs/content/references/js-client/classes/internal.AdminGetRegionsParams.md deleted file mode 100644 index 88e932922f..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetRegionsParams.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetRegionsParams - -[internal](../modules/internal.md).AdminGetRegionsParams - -## Hierarchy - -- [`AdminGetRegionsPaginationParams`](internal.AdminGetRegionsPaginationParams.md) - - ↳ **`AdminGetRegionsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:60 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:62 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -[AdminGetRegionsPaginationParams](internal.AdminGetRegionsPaginationParams.md).[limit](internal.AdminGetRegionsPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:56 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[AdminGetRegionsPaginationParams](internal.AdminGetRegionsPaginationParams.md).[offset](internal.AdminGetRegionsPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:57 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.md b/docs/content/references/js-client/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.md deleted file mode 100644 index ca7efe7b94..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetRegionsRegionFulfillmentOptionsRes - -[internal](../modules/internal.md).AdminGetRegionsRegionFulfillmentOptionsRes - -## Properties - -### fulfillment\_options - -• **fulfillment\_options**: [`FulfillmentOption`](internal.FulfillmentOption.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/index.d.ts:20 diff --git a/docs/content/references/js-client/classes/internal.AdminGetReturnsParams.md b/docs/content/references/js-client/classes/internal.AdminGetReturnsParams.md deleted file mode 100644 index 797acaff29..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetReturnsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetReturnsParams - -[internal](../modules/internal.md).AdminGetReturnsParams - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/returns/list-returns.d.ts:26 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/returns/list-returns.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal.AdminGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal.AdminGetShippingOptionsParams.md deleted file mode 100644 index d31cfe51a7..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetShippingOptionsParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetShippingOptionsParams - -[internal](../modules/internal.md).AdminGetShippingOptionsParams - -## Properties - -### admin\_only - -• `Optional` **admin\_only**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:45 - -___ - -### is\_return - -• `Optional` **is\_return**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:44 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:43 diff --git a/docs/content/references/js-client/classes/internal.AdminGetSwapsParams.md b/docs/content/references/js-client/classes/internal.AdminGetSwapsParams.md deleted file mode 100644 index cb1ffc4f1d..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetSwapsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetSwapsParams - -[internal](../modules/internal.md).AdminGetSwapsParams - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:24 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.AdminGetTaxRatesParams.md b/docs/content/references/js-client/classes/internal.AdminGetTaxRatesParams.md deleted file mode 100644 index 82ca520b00..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetTaxRatesParams.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetTaxRatesParams - -[internal](../modules/internal.md).AdminGetTaxRatesParams - -## Properties - -### code - -• `Optional` **code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:38 - -___ - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:42 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:43 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:41 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:37 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:40 - -___ - -### rate - -• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal.NumericalComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:39 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` \| `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:36 diff --git a/docs/content/references/js-client/classes/internal.AdminGetTaxRatesTaxRateParams.md b/docs/content/references/js-client/classes/internal.AdminGetTaxRatesTaxRateParams.md deleted file mode 100644 index 110b6cd2d1..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetTaxRatesTaxRateParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetTaxRatesTaxRateParams - -[internal](../modules/internal.md).AdminGetTaxRatesTaxRateParams - -## Properties - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:24 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.AdminGetVariantsParams.md b/docs/content/references/js-client/classes/internal.AdminGetVariantsParams.md deleted file mode 100644 index 1bc1319968..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminGetVariantsParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminGetVariantsParams - -[internal](../modules/internal.md).AdminGetVariantsParams - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:29 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:30 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminListCustomerSelector.md b/docs/content/references/js-client/classes/internal.AdminListCustomerSelector.md deleted file mode 100644 index 9f48d1419d..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminListCustomerSelector.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminListCustomerSelector - -[internal](../modules/internal.md).AdminListCustomerSelector - -## Hierarchy - -- **`AdminListCustomerSelector`** - - ↳ [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md) - -## Properties - -### groups - -• `Optional` **groups**: `string`[] - -#### Defined in - -packages/medusa/dist/types/customers.d.ts:3 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/types/customers.d.ts:2 diff --git a/docs/content/references/js-client/classes/internal.AdminPostAuthReq.md b/docs/content/references/js-client/classes/internal.AdminPostAuthReq.md deleted file mode 100644 index d9a663a816..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostAuthReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostAuthReq - -[internal](../modules/internal.md).AdminPostAuthReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:25 - -___ - -### password - -• **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCollectionsCollectionReq.md b/docs/content/references/js-client/classes/internal.AdminPostCollectionsCollectionReq.md deleted file mode 100644 index 158dcfce33..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostCollectionsCollectionReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostCollectionsCollectionReq - -[internal](../modules/internal.md).AdminPostCollectionsCollectionReq - -## Properties - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:39 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:40 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:38 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCollectionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostCollectionsReq.md deleted file mode 100644 index aa6b1bb59e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostCollectionsReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostCollectionsReq - -[internal](../modules/internal.md).AdminPostCollectionsReq - -## Properties - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:39 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:40 - -___ - -### title - -• **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:38 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md deleted file mode 100644 index 0755cee9d7..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostCustomerGroupsGroupCustomersBatchReq - -[internal](../modules/internal.md).AdminPostCustomerGroupsGroupCustomersBatchReq - -## Properties - -### customer\_ids - -• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal.CustomerGroupsBatchCustomer.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupReq.md deleted file mode 100644 index d0960b3325..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostCustomerGroupsGroupReq - -[internal](../modules/internal.md).AdminPostCustomerGroupsGroupReq - -## Properties - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:27 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsReq.md deleted file mode 100644 index 85ab073913..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostCustomerGroupsReq - -[internal](../modules/internal.md).AdminPostCustomerGroupsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:26 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomersCustomerReq.md deleted file mode 100644 index 25d70281e7..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostCustomersCustomerReq.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostCustomersCustomerReq - -[internal](../modules/internal.md).AdminPostCustomersCustomerReq - -## Properties - -### email - -• `Optional` **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:60 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:61 - -___ - -### groups - -• `Optional` **groups**: [`Group`](internal.Group.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:66 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:62 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:65 - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:63 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:64 diff --git a/docs/content/references/js-client/classes/internal.AdminPostCustomersReq.md b/docs/content/references/js-client/classes/internal.AdminPostCustomersReq.md deleted file mode 100644 index f43ffb8951..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostCustomersReq.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostCustomersReq - -[internal](../modules/internal.md).AdminPostCustomersReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:28 - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:29 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:30 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:33 - -___ - -### password - -• **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:31 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditions.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditions.md deleted file mode 100644 index 3e6dbaa1b1..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditions.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountConditions - -[internal](../modules/internal.md).AdminPostDiscountsDiscountConditions - -## Hierarchy - -- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md) - - ↳ **`AdminPostDiscountsDiscountConditions`** - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:21 - -___ - -### operator - -• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts:53 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:18 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:20 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:19 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsCondition.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsCondition.md deleted file mode 100644 index dda2091105..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsCondition.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountConditionsCondition - -[internal](../modules/internal.md).AdminPostDiscountsDiscountConditionsCondition - -## Hierarchy - -- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md) - - ↳ **`AdminPostDiscountsDiscountConditionsCondition`** - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:21 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:18 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:20 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:19 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.md deleted file mode 100644 index 6502912077..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountConditionsConditionParams - -[internal](../modules/internal.md).AdminPostDiscountsDiscountConditionsConditionParams - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-condition.d.ts:53 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-condition.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsParams.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsParams.md deleted file mode 100644 index 8d476ca517..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsParams.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountConditionsParams - -[internal](../modules/internal.md).AdminPostDiscountsDiscountConditionsParams - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts:56 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountDynamicCodesReq.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountDynamicCodesReq.md deleted file mode 100644 index d080d90381..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountDynamicCodesReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountDynamicCodesReq - -[internal](../modules/internal.md).AdminPostDiscountsDiscountDynamicCodesReq - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:27 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:29 - -___ - -### usage\_limit - -• **usage\_limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountReq.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountReq.md deleted file mode 100644 index fb3ce811bd..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountReq.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsDiscountReq - -[internal](../modules/internal.md).AdminPostDiscountsDiscountReq - -## Properties - -### code - -• `Optional` **code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:56 - -___ - -### ends\_at - -• `Optional` **ends\_at**: ``null`` \| [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:60 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:58 - -___ - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:64 - -___ - -### regions - -• `Optional` **regions**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:63 - -___ - -### rule - -• `Optional` **rule**: [`AdminUpdateDiscountRule`](internal.AdminUpdateDiscountRule.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:57 - -___ - -### starts\_at - -• `Optional` **starts\_at**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:59 - -___ - -### usage\_limit - -• `Optional` **usage\_limit**: ``null`` \| `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:62 - -___ - -### valid\_duration - -• `Optional` **valid\_duration**: ``null`` \| `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDiscountsReq.md b/docs/content/references/js-client/classes/internal.AdminPostDiscountsReq.md deleted file mode 100644 index 180b77852d..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDiscountsReq.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDiscountsReq - -[internal](../modules/internal.md).AdminPostDiscountsReq - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:65 - -___ - -### ends\_at - -• `Optional` **ends\_at**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:70 - -___ - -### is\_disabled - -• **is\_disabled**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:68 - -___ - -### is\_dynamic - -• **is\_dynamic**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:67 - -___ - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:74 - -___ - -### regions - -• `Optional` **regions**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:73 - -___ - -### rule - -• **rule**: [`AdminPostDiscountsDiscountRule`](internal.AdminPostDiscountsDiscountRule.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:66 - -___ - -### starts\_at - -• `Optional` **starts\_at**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:69 - -___ - -### usage\_limit - -• `Optional` **usage\_limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:72 - -___ - -### valid\_duration - -• `Optional` **valid\_duration**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:71 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md b/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md deleted file mode 100644 index bbd30c844d..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDraftOrdersDraftOrderLineItemsItemReq - -[internal](../modules/internal.md).AdminPostDraftOrdersDraftOrderLineItemsItemReq - -## Properties - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:42 - -___ - -### quantity - -• `Optional` **quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:41 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:39 - -___ - -### unit\_price - -• `Optional` **unit\_price**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:40 diff --git a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md b/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md deleted file mode 100644 index 233c8acc55..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostDraftOrdersDraftOrderLineItemsReq - -[internal](../modules/internal.md).AdminPostDraftOrdersDraftOrderLineItemsReq - -## Properties - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:48 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:47 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:44 - -___ - -### unit\_price - -• `Optional` **unit\_price**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:45 - -___ - -### variant\_id - -• `Optional` **variant\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:46 diff --git a/docs/content/references/js-client/classes/internal.AdminPostGiftCardsGiftCardReq.md b/docs/content/references/js-client/classes/internal.AdminPostGiftCardsGiftCardReq.md deleted file mode 100644 index 6a095e874f..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostGiftCardsGiftCardReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostGiftCardsGiftCardReq - -[internal](../modules/internal.md).AdminPostGiftCardsGiftCardReq - -## Properties - -### balance - -• `Optional` **balance**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:47 - -___ - -### ends\_at - -• `Optional` **ends\_at**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:49 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:48 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:51 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:50 diff --git a/docs/content/references/js-client/classes/internal.AdminPostGiftCardsReq.md b/docs/content/references/js-client/classes/internal.AdminPostGiftCardsReq.md deleted file mode 100644 index e2ef81f897..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostGiftCardsReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostGiftCardsReq - -[internal](../modules/internal.md).AdminPostGiftCardsReq - -## Properties - -### ends\_at - -• `Optional` **ends\_at**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:46 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:47 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:49 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:48 - -___ - -### value - -• `Optional` **value**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptReq.md b/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptReq.md deleted file mode 100644 index a2542f8702..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostInvitesInviteAcceptReq - -[internal](../modules/internal.md).AdminPostInvitesInviteAcceptReq - -## Properties - -### token - -• **token**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:48 - -___ - -### user - -• **user**: [`AdminPostInvitesInviteAcceptUserReq`](internal.AdminPostInvitesInviteAcceptUserReq.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptUserReq.md b/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptUserReq.md deleted file mode 100644 index d5a3e7db3e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostInvitesInviteAcceptUserReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostInvitesInviteAcceptUserReq - -[internal](../modules/internal.md).AdminPostInvitesInviteAcceptUserReq - -## Properties - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:43 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:44 - -___ - -### password - -• **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.AdminPostInvitesReq.md b/docs/content/references/js-client/classes/internal.AdminPostInvitesReq.md deleted file mode 100644 index 6cda3af301..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostInvitesReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostInvitesReq - -[internal](../modules/internal.md).AdminPostInvitesReq - -## Properties - -### role - -• **role**: [`UserRoles`](../enums/internal.UserRoles.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/invites/create-invite.d.ts:32 - -___ - -### user - -• **user**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/invites/create-invite.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminPostNotesNoteReq.md b/docs/content/references/js-client/classes/internal.AdminPostNotesNoteReq.md deleted file mode 100644 index b4f1c6214d..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostNotesNoteReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostNotesNoteReq - -[internal](../modules/internal.md).AdminPostNotesNoteReq - -## Properties - -### value - -• **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notes/update-note.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal.AdminPostNotesReq.md b/docs/content/references/js-client/classes/internal.AdminPostNotesReq.md deleted file mode 100644 index b13de4005d..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostNotesReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostNotesReq - -[internal](../modules/internal.md).AdminPostNotesReq - -## Properties - -### resource\_id - -• **resource\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:37 - -___ - -### resource\_type - -• **resource\_type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:38 - -___ - -### value - -• **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal.AdminPostNotificationsNotificationResendReq.md b/docs/content/references/js-client/classes/internal.AdminPostNotificationsNotificationResendReq.md deleted file mode 100644 index 385daf7c6e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostNotificationsNotificationResendReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostNotificationsNotificationResendReq - -[internal](../modules/internal.md).AdminPostNotificationsNotificationResendReq - -## Properties - -### to - -• `Optional` **to**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/notifications/resend-notification.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md deleted file mode 100644 index 7b2c8be636..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderClaimsClaimFulfillmentsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderClaimsClaimFulfillmentsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:36 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:37 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimReq.md deleted file mode 100644 index 54c0b670f7..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimReq.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderClaimsClaimReq - -[internal](../modules/internal.md).AdminPostOrdersOrderClaimsClaimReq - -## Properties - -### claim\_items - -• `Optional` **claim\_items**: `Item`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:84 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:87 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:86 - -___ - -### shipping\_methods - -• `Optional` **shipping\_methods**: `ShippingMethod`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md deleted file mode 100644 index 7b6c130bcb..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderClaimsClaimShipmentsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderClaimsClaimShipmentsReq - -## Properties - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:40 - -___ - -### tracking\_numbers - -• `Optional` **tracking\_numbers**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:41 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsReq.md deleted file mode 100644 index 11c97e4893..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderClaimsReq.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderClaimsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderClaimsReq - -## Properties - -### additional\_items - -• `Optional` **additional\_items**: `AdditionalItem`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:132 - -___ - -### claim\_items - -• **claim\_items**: `Item`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:130 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:137 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:136 - -___ - -### refund\_amount - -• `Optional` **refund\_amount**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:134 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: `ReturnShipping` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:131 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:135 - -___ - -### shipping\_methods - -• `Optional` **shipping\_methods**: `ShippingMethod`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:133 - -___ - -### type - -• **type**: ``"replace"`` \| ``"refund"`` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:129 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderFulfillmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderFulfillmentsReq.md deleted file mode 100644 index c036e00869..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderFulfillmentsReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderFulfillmentsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderFulfillmentsReq - -## Properties - -### items - -• **items**: [`Item`](internal.Item.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:48 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:50 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderRefundsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderRefundsReq.md deleted file mode 100644 index 3ab38e8e28..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderRefundsReq.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderRefundsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderRefundsReq - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:44 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:47 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:46 - -___ - -### reason - -• **reason**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReq.md deleted file mode 100644 index 05ccfdded0..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReq.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderReq - -[internal](../modules/internal.md).AdminPostOrdersOrderReq - -## Properties - -### billing\_address - -• `Optional` **billing\_address**: [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:86 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:91 - -___ - -### discounts - -• `Optional` **discounts**: `object`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:90 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:85 - -___ - -### items - -• `Optional` **items**: `object`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:88 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:94 - -___ - -### payment\_method - -• `Optional` **payment\_method**: `PaymentMethod` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:92 - -___ - -### region - -• `Optional` **region**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:89 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:87 - -___ - -### shipping\_method - -• `Optional` **shipping\_method**: `ShippingMethod`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:93 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReturnsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReturnsReq.md deleted file mode 100644 index a609af6ce3..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderReturnsReq.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderReturnsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderReturnsReq - -## Properties - -### items - -• **items**: [`OrdersReturnItem`](internal.OrdersReturnItem.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:68 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:72 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:70 - -___ - -### receive\_now - -• `Optional` **receive\_now**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:71 - -___ - -### refund - -• `Optional` **refund**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:73 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: [`ReturnShipping`](internal.ReturnShipping.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:69 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShippingMethodsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShippingMethodsReq.md deleted file mode 100644 index ed9c504e64..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderShippingMethodsReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderShippingMethodsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderShippingMethodsReq - -## Properties - -### data - -• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:29 - -___ - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:28 - -___ - -### price - -• **price**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsReq.md deleted file mode 100644 index 009d3832f9..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsReq.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderSwapsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderSwapsReq - -## Properties - -### additional\_items - -• `Optional` **additional\_items**: [`AdditionalItem`](internal.AdditionalItem.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:91 - -___ - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:94 - -___ - -### custom\_shipping\_options - -• `Optional` **custom\_shipping\_options**: [`CustomShippingOption`](internal.CustomShippingOption.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:92 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:93 - -___ - -### return\_items - -• **return\_items**: `ReturnItem`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:89 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: `ReturnShipping` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:90 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md deleted file mode 100644 index e8a16b0c44..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderSwapsSwapFulfillmentsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:36 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:37 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md deleted file mode 100644 index 25b287223b..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersOrderSwapsSwapShipmentsReq - -[internal](../modules/internal.md).AdminPostOrdersOrderSwapsSwapShipmentsReq - -## Properties - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:43 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:45 - -___ - -### tracking\_numbers - -• `Optional` **tracking\_numbers**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:44 diff --git a/docs/content/references/js-client/classes/internal.AdminPostOrdersReq.md b/docs/content/references/js-client/classes/internal.AdminPostOrdersReq.md deleted file mode 100644 index 3c6f65f917..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostOrdersReq.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostOrdersReq - -[internal](../modules/internal.md).AdminPostOrdersReq - -## Properties - -### billing\_address - -• **billing\_address**: [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:103 - -___ - -### customer\_id - -• **customer\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:108 - -___ - -### discounts - -• `Optional` **discounts**: `object`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:107 - -___ - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:102 - -___ - -### items - -• **items**: `object`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:105 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:111 - -___ - -### payment\_method - -• **payment\_method**: [`PaymentMethod`](internal.PaymentMethod.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:109 - -___ - -### region - -• **region**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:106 - -___ - -### shipping\_address - -• **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:104 - -___ - -### shipping\_method - -• `Optional` **shipping\_method**: `ShippingMethod`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:110 - -___ - -### status - -• `Optional` **status**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:101 diff --git a/docs/content/references/js-client/classes/internal.AdminPostPriceListPricesPricesReq.md b/docs/content/references/js-client/classes/internal.AdminPostPriceListPricesPricesReq.md deleted file mode 100644 index 6ef02f8add..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostPriceListPricesPricesReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostPriceListPricesPricesReq - -[internal](../modules/internal.md).AdminPostPriceListPricesPricesReq - -## Properties - -### override - -• `Optional` **override**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:69 - -___ - -### prices - -• **prices**: [`AdminPriceListPricesUpdateReq`](internal.AdminPriceListPricesUpdateReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:68 diff --git a/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListPriceListReq.md b/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListPriceListReq.md deleted file mode 100644 index ba63042d10..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListPriceListReq.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostPriceListsPriceListPriceListReq - -[internal](../modules/internal.md).AdminPostPriceListsPriceListPriceListReq - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `CustomerGroup`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:91 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:85 - -___ - -### ends\_at - -• `Optional` **ends\_at**: ``null`` \| [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:87 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:84 - -___ - -### prices - -• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal.AdminPriceListPricesUpdateReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:90 - -___ - -### starts\_at - -• `Optional` **starts\_at**: ``null`` \| [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:86 - -___ - -### status - -• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:88 - -___ - -### type - -• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:89 diff --git a/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListReq.md b/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListReq.md deleted file mode 100644 index 5dc196cfb9..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostPriceListsPriceListReq.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostPriceListsPriceListReq - -[internal](../modules/internal.md).AdminPostPriceListsPriceListReq - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `CustomerGroup`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:86 - -___ - -### description - -• **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:80 - -___ - -### ends\_at - -• `Optional` **ends\_at**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:82 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:79 - -___ - -### prices - -• **prices**: [`AdminPriceListPricesCreateReq`](internal.AdminPriceListPricesCreateReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:85 - -___ - -### starts\_at - -• `Optional` **starts\_at**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:81 - -___ - -### status - -• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:83 - -___ - -### type - -• **type**: [`PriceListType`](../enums/internal.PriceListType.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:84 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductMetadataReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductMetadataReq.md deleted file mode 100644 index b2e570caf4..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostProductsProductMetadataReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostProductsProductMetadataReq - -[internal](../modules/internal.md).AdminPostProductsProductMetadataReq - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/set-metadata.d.ts:38 - -___ - -### value - -• **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/set-metadata.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsOption.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsOption.md deleted file mode 100644 index b702ab7a6e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsOption.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostProductsProductOptionsOption - -[internal](../modules/internal.md).AdminPostProductsProductOptionsOption - -## Properties - -### title - -• **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-option.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsReq.md deleted file mode 100644 index 70b7f4267f..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostProductsProductOptionsReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostProductsProductOptionsReq - -[internal](../modules/internal.md).AdminPostProductsProductOptionsReq - -## Properties - -### title - -• **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/add-option.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductReq.md deleted file mode 100644 index 548b4c0f4a..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostProductsProductReq.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostProductsProductReq - -[internal](../modules/internal.md).AdminPostProductsProductReq - -## Properties - -### collection\_id - -• `Optional` **collection\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:232 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:225 - -___ - -### discountable - -• `Optional` **discountable**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:226 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:229 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:237 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:239 - -___ - -### images - -• **images**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:227 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:236 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:242 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:243 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:241 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:240 - -___ - -### status - -• `Optional` **status**: `ProductStatus` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:230 - -___ - -### subtitle - -• `Optional` **subtitle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:224 - -___ - -### tags - -• `Optional` **tags**: `ProductTagReq`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:233 - -___ - -### thumbnail - -• `Optional` **thumbnail**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:228 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:223 - -___ - -### type - -• `Optional` **type**: `ProductTypeReq` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:231 - -___ - -### variants - -• `Optional` **variants**: `ProductVariantReq`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:234 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:235 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-product.d.ts:238 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsReq.md deleted file mode 100644 index a364dea090..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsReq.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostProductsProductVariantsReq - -[internal](../modules/internal.md).AdminPostProductsProductVariantsReq - -## Properties - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:125 - -___ - -### barcode - -• `Optional` **barcode**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:122 - -___ - -### ean - -• `Optional` **ean**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:120 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:129 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:123 - -___ - -### inventory\_quantity - -• **inventory\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:124 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:128 - -___ - -### manage\_inventory - -• `Optional` **manage\_inventory**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:126 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:133 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:134 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:132 - -___ - -### options - -• **options**: [`ProductVariantOptionReq`](internal.ProductVariantOptionReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:136 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:131 - -___ - -### prices - -• **prices**: [`ProductVariantPricesCreateReq`](internal.ProductVariantPricesCreateReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:135 - -___ - -### sku - -• `Optional` **sku**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:119 - -___ - -### title - -• **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:118 - -___ - -### upc - -• `Optional` **upc**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:121 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:127 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:130 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsVariantReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsVariantReq.md deleted file mode 100644 index cc04afd4b9..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostProductsProductVariantsVariantReq.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostProductsProductVariantsVariantReq - -[internal](../modules/internal.md).AdminPostProductsProductVariantsVariantReq - -## Properties - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:125 - -___ - -### barcode - -• `Optional` **barcode**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:122 - -___ - -### ean - -• `Optional` **ean**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:120 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:129 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:123 - -___ - -### inventory\_quantity - -• **inventory\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:124 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:128 - -___ - -### manage\_inventory - -• `Optional` **manage\_inventory**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:126 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:133 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:134 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:132 - -___ - -### options - -• **options**: `ProductVariantOptionReq`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:136 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:131 - -___ - -### prices - -• **prices**: [`ProductVariantPricesUpdateReq`](internal.ProductVariantPricesUpdateReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:135 - -___ - -### sku - -• `Optional` **sku**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:119 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:118 - -___ - -### upc - -• `Optional` **upc**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:121 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:127 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:130 diff --git a/docs/content/references/js-client/classes/internal.AdminPostProductsReq.md b/docs/content/references/js-client/classes/internal.AdminPostProductsReq.md deleted file mode 100644 index b9aa7f17dc..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostProductsReq.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostProductsReq - -[internal](../modules/internal.md).AdminPostProductsReq - -## Properties - -### collection\_id - -• `Optional` **collection\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:238 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:230 - -___ - -### discountable - -• **discountable**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:232 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:235 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:244 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:246 - -___ - -### images - -• `Optional` **images**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:233 - -___ - -### is\_giftcard - -• **is\_giftcard**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:231 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:243 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:249 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:250 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:248 - -___ - -### options - -• `Optional` **options**: [`ProductOptionReq`](internal.ProductOptionReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:240 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:247 - -___ - -### status - -• `Optional` **status**: `ProductStatus` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:236 - -___ - -### subtitle - -• `Optional` **subtitle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:229 - -___ - -### tags - -• `Optional` **tags**: [`ProductTagReq`](internal.ProductTagReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:239 - -___ - -### thumbnail - -• `Optional` **thumbnail**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:234 - -___ - -### title - -• **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:228 - -___ - -### type - -• `Optional` **type**: [`ProductTypeReq`](internal.ProductTypeReq.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:237 - -___ - -### variants - -• `Optional` **variants**: [`ProductVariantReq`](internal.ProductVariantReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:241 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:242 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:245 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionCountriesReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionCountriesReq.md deleted file mode 100644 index 80c57af7d7..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionCountriesReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostRegionsRegionCountriesReq - -[internal](../modules/internal.md).AdminPostRegionsRegionCountriesReq - -## Properties - -### country\_code - -• **country\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/add-country.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionFulfillmentProvidersReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionFulfillmentProvidersReq.md deleted file mode 100644 index 4a788ee15c..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionFulfillmentProvidersReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostRegionsRegionFulfillmentProvidersReq - -[internal](../modules/internal.md).AdminPostRegionsRegionFulfillmentProvidersReq - -## Properties - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionMetadata.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionMetadata.md deleted file mode 100644 index 7d74865356..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionMetadata.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostRegionsRegionMetadata - -[internal](../modules/internal.md).AdminPostRegionsRegionMetadata - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/set-metadata.d.ts:26 - -___ - -### value - -• **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/set-metadata.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionPaymentProvidersReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionPaymentProvidersReq.md deleted file mode 100644 index 01d5ab3935..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostRegionsRegionPaymentProvidersReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostRegionsRegionPaymentProvidersReq - -[internal](../modules/internal.md).AdminPostRegionsRegionPaymentProvidersReq - -## Properties - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.AdminPostRegionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostRegionsReq.md deleted file mode 100644 index 9dbf857194..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostRegionsReq.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostRegionsReq - -[internal](../modules/internal.md).AdminPostRegionsReq - -## Properties - -### countries - -• **countries**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:64 - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:59 - -___ - -### fulfillment\_providers - -• **fulfillment\_providers**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:63 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:58 - -___ - -### payment\_providers - -• **payment\_providers**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:62 - -___ - -### tax\_code - -• `Optional` **tax\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:60 - -___ - -### tax\_rate - -• **tax\_rate**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:61 diff --git a/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReasonReq.md b/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReasonReq.md deleted file mode 100644 index 1f4288a3e3..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReasonReq.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostReturnReasonsReasonReq - -[internal](../modules/internal.md).AdminPostReturnReasonsReasonReq - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:40 - -___ - -### label - -• `Optional` **label**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:38 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:41 - -___ - -### value - -• `Optional` **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReq.md b/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReq.md deleted file mode 100644 index 72e2ade71e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostReturnReasonsReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostReturnReasonsReq - -[internal](../modules/internal.md).AdminPostReturnReasonsReq - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:48 - -___ - -### label - -• **label**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:46 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:49 - -___ - -### parent\_return\_reason\_id - -• `Optional` **parent\_return\_reason\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:47 - -___ - -### value - -• **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.AdminPostReturnsReturnReceiveReq.md b/docs/content/references/js-client/classes/internal.AdminPostReturnsReturnReceiveReq.md deleted file mode 100644 index 3cec0c3b6a..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostReturnsReturnReceiveReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostReturnsReturnReceiveReq - -[internal](../modules/internal.md).AdminPostReturnsReturnReceiveReq - -## Properties - -### items - -• **items**: `Item`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:48 - -___ - -### refund - -• `Optional` **refund**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:49 diff --git a/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsOptionReq.md b/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsOptionReq.md deleted file mode 100644 index 70a00bb6e3..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsOptionReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostShippingOptionsOptionReq - -[internal](../modules/internal.md).AdminPostShippingOptionsOptionReq - -## Properties - -### admin\_only - -• `Optional` **admin\_only**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:63 - -___ - -### amount - -• `Optional` **amount**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:61 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:64 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:60 - -___ - -### requirements - -• **requirements**: `OptionRequirement`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:62 diff --git a/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsReq.md deleted file mode 100644 index 680b20b4f1..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostShippingOptionsReq.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostShippingOptionsReq - -[internal](../modules/internal.md).AdminPostShippingOptionsReq - -## Properties - -### admin\_only - -• `Optional` **admin\_only**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:86 - -___ - -### amount - -• `Optional` **amount**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:84 - -___ - -### data - -• **data**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:82 - -___ - -### is\_return - -• `Optional` **is\_return**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:87 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:88 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:78 - -___ - -### price\_type - -• **price\_type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:83 - -___ - -### profile\_id - -• `Optional` **profile\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:81 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:80 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:79 - -___ - -### requirements - -• `Optional` **requirements**: [`OptionRequirement`](internal.OptionRequirement.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:85 diff --git a/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesProfileReq.md b/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesProfileReq.md deleted file mode 100644 index 182d397fff..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesProfileReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostShippingProfilesProfileReq - -[internal](../modules/internal.md).AdminPostShippingProfilesProfileReq - -## Properties - -### name - -• `Optional` **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesReq.md b/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesReq.md deleted file mode 100644 index 0050479d49..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostShippingProfilesReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostShippingProfilesReq - -[internal](../modules/internal.md).AdminPostShippingProfilesReq - -## Properties - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesReq.md deleted file mode 100644 index 0c94ba3132..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesReq.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostTaxRatesReq - -[internal](../modules/internal.md).AdminPostTaxRatesReq - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:24 - -___ - -### name - -• **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:25 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:30 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:28 - -___ - -### rate - -• `Optional` **rate**: ``null`` \| `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:27 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:26 - -___ - -### shipping\_options - -• `Optional` **shipping\_options**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductTypesReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductTypesReq.md deleted file mode 100644 index f6b08242d4..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductTypesReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostTaxRatesTaxRateProductTypesReq - -[internal](../modules/internal.md).AdminPostTaxRatesTaxRateProductTypesReq - -## Properties - -### product\_types - -• **product\_types**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductsReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductsReq.md deleted file mode 100644 index 9c5c2f8c86..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateProductsReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostTaxRatesTaxRateProductsReq - -[internal](../modules/internal.md).AdminPostTaxRatesTaxRateProductsReq - -## Properties - -### products - -• **products**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateReq.md deleted file mode 100644 index 1a61d4ef75..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateReq.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostTaxRatesTaxRateReq - -[internal](../modules/internal.md).AdminPostTaxRatesTaxRateReq - -## Properties - -### code - -• `Optional` **code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:24 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:25 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:30 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:28 - -___ - -### rate - -• `Optional` **rate**: ``null`` \| `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:27 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:26 - -___ - -### shipping\_options - -• `Optional` **shipping\_options**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md b/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md deleted file mode 100644 index 0eb105754f..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminPostTaxRatesTaxRateShippingOptionsReq - -[internal](../modules/internal.md).AdminPostTaxRatesTaxRateShippingOptionsReq - -## Properties - -### shipping\_options - -• **shipping\_options**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.AdminRegionsRes.md b/docs/content/references/js-client/classes/internal.AdminRegionsRes.md deleted file mode 100644 index 3750b2ce6e..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminRegionsRes.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminRegionsRes - -[internal](../modules/internal.md).AdminRegionsRes - -## Properties - -### region - -• **region**: [`Region`](internal.Region.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/index.d.ts:9 diff --git a/docs/content/references/js-client/classes/internal.AdminResetPasswordRequest.md b/docs/content/references/js-client/classes/internal.AdminResetPasswordRequest.md deleted file mode 100644 index e6a25356a3..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminResetPasswordRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminResetPasswordRequest - -[internal](../modules/internal.md).AdminResetPasswordRequest - -## Properties - -### email - -• `Optional` **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:45 - -___ - -### password - -• **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:47 - -___ - -### token - -• **token**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:46 diff --git a/docs/content/references/js-client/classes/internal.AdminResetPasswordTokenRequest.md b/docs/content/references/js-client/classes/internal.AdminResetPasswordTokenRequest.md deleted file mode 100644 index d3f38fb1e6..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminResetPasswordTokenRequest.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminResetPasswordTokenRequest - -[internal](../modules/internal.md).AdminResetPasswordTokenRequest - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/reset-password-token.d.ts:26 diff --git a/docs/content/references/js-client/classes/internal.AdminUpdateDiscountRule.md b/docs/content/references/js-client/classes/internal.AdminUpdateDiscountRule.md deleted file mode 100644 index 77506f023b..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminUpdateDiscountRule.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminUpdateDiscountRule - -[internal](../modules/internal.md).AdminUpdateDiscountRule - -## Properties - -### allocation - -• `Optional` **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:70 - -___ - -### conditions - -• `Optional` **conditions**: [`AdminUpsertCondition`](internal.AdminUpsertCondition.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:71 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:68 - -___ - -### id - -• **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:67 - -___ - -### value - -• `Optional` **value**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:69 diff --git a/docs/content/references/js-client/classes/internal.AdminUpdateUserRequest.md b/docs/content/references/js-client/classes/internal.AdminUpdateUserRequest.md deleted file mode 100644 index 12c727721f..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminUpdateUserRequest.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminUpdateUserRequest - -[internal](../modules/internal.md).AdminUpdateUserRequest - -## Properties - -### api\_token - -• `Optional` **api\_token**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/update-user.d.ts:32 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/update-user.d.ts:29 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/update-user.d.ts:30 - -___ - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/update-user.d.ts:33 - -___ - -### role - -• `Optional` **role**: [`UserRoles`](../enums/internal.UserRoles.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/users/update-user.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.AdminUpsertCondition.md b/docs/content/references/js-client/classes/internal.AdminUpsertCondition.md deleted file mode 100644 index 2d9c08245b..0000000000 --- a/docs/content/references/js-client/classes/internal.AdminUpsertCondition.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: AdminUpsertCondition - -[internal](../modules/internal.md).AdminUpsertCondition - -## Hierarchy - -- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md) - - ↳ **`AdminUpsertCondition`** - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:21 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:74 - -___ - -### operator - -• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:75 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:18 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:20 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:19 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products) - -#### Defined in - -packages/medusa/dist/types/discount.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.Axios.md b/docs/content/references/js-client/classes/internal.Axios.md index 862690d82f..4f4afefbb7 100644 --- a/docs/content/references/js-client/classes/internal.Axios.md +++ b/docs/content/references/js-client/classes/internal.Axios.md @@ -20,7 +20,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:171 +medusa-js/node_modules/axios/index.d.ts:171 ___ @@ -37,13 +37,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:172 +medusa-js/node_modules/axios/index.d.ts:172 ## Methods ### delete -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> #### Type parameters @@ -62,17 +62,17 @@ packages/medusa-js/node_modules/axios/index.d.ts:172 #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:179 +medusa-js/node_modules/axios/index.d.ts:179 ___ ### get -▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> #### Type parameters @@ -91,11 +91,11 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:178 +medusa-js/node_modules/axios/index.d.ts:178 ___ @@ -115,13 +115,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:176 +medusa-js/node_modules/axios/index.d.ts:176 ___ ### head -▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> #### Type parameters @@ -140,17 +140,17 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:180 +medusa-js/node_modules/axios/index.d.ts:180 ___ ### options -▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> #### Type parameters @@ -169,17 +169,17 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:181 +medusa-js/node_modules/axios/index.d.ts:181 ___ ### patch -▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> #### Type parameters @@ -199,17 +199,17 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:184 +medusa-js/node_modules/axios/index.d.ts:184 ___ ### post -▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> #### Type parameters @@ -229,17 +229,17 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:182 +medusa-js/node_modules/axios/index.d.ts:182 ___ ### put -▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> #### Type parameters @@ -259,17 +259,17 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:183 +medusa-js/node_modules/axios/index.d.ts:183 ___ ### request -▸ **request**<`T`, `R`, `D`\>(`config`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> #### Type parameters @@ -287,8 +287,8 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:177 +medusa-js/node_modules/axios/index.d.ts:177 diff --git a/docs/content/references/js-client/classes/internal.BaseEntity.md b/docs/content/references/js-client/classes/internal.BaseEntity.md index ac5e39111d..5a995606da 100644 --- a/docs/content/references/js-client/classes/internal.BaseEntity.md +++ b/docs/content/references/js-client/classes/internal.BaseEntity.md @@ -34,19 +34,19 @@ Base abstract entity for all entities ↳ [`TaxLine`](internal.TaxLine.md) - ↳ [`Notification`](internal.Notification.md) + ↳ [`Notification`](internal-11.Notification.md) - ↳ [`Store`](internal.Store.md) + ↳ [`Store`](internal-23.Store.md) ## Properties ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -56,14 +56,14 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.Cart.md b/docs/content/references/js-client/classes/internal.Cart.md index a55dc23ead..b0816068d5 100644 --- a/docs/content/references/js-client/classes/internal.Cart.md +++ b/docs/content/references/js-client/classes/internal.Cart.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Cart +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/cart.d.ts:134 +medusa/dist/models/cart.d.ts:138 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:135 +medusa/dist/models/cart.d.ts:139 ___ @@ -40,7 +42,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:105 +medusa/dist/models/cart.d.ts:106 ___ @@ -50,33 +52,33 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:104 +medusa/dist/models/cart.d.ts:105 ___ ### completed\_at -• **completed\_at**: [`Date`](../modules/internal.md#date) +• **completed\_at**: `Date` #### Defined in -packages/medusa/dist/models/cart.d.ts:121 +medusa/dist/models/cart.d.ts:122 ___ ### context -• **context**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **context**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/cart.d.ts:124 +medusa/dist/models/cart.d.ts:125 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -84,7 +86,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -94,7 +96,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:114 +medusa/dist/models/cart.d.ts:115 ___ @@ -104,13 +106,13 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:113 +medusa/dist/models/cart.d.ts:114 ___ ### deleted\_at -• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **deleted\_at**: ``null`` \| `Date` #### Inherited from @@ -118,7 +120,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -128,7 +130,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:127 +medusa/dist/models/cart.d.ts:130 ___ @@ -138,7 +140,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:111 +medusa/dist/models/cart.d.ts:112 ___ @@ -148,7 +150,17 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:103 +medusa/dist/models/cart.d.ts:104 + +___ + +### gift\_card\_tax\_total + +• `Optional` **gift\_card\_tax\_total**: `number` + +#### Defined in + +medusa/dist/models/cart.d.ts:137 ___ @@ -158,7 +170,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:133 +medusa/dist/models/cart.d.ts:136 ___ @@ -168,7 +180,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:112 +medusa/dist/models/cart.d.ts:113 ___ @@ -182,7 +194,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -192,7 +204,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:123 +medusa/dist/models/cart.d.ts:124 ___ @@ -202,17 +214,17 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:108 +medusa/dist/models/cart.d.ts:109 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/cart.d.ts:125 +medusa/dist/models/cart.d.ts:126 ___ @@ -222,7 +234,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:102 +medusa/dist/models/cart.d.ts:103 ___ @@ -232,17 +244,17 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:118 +medusa/dist/models/cart.d.ts:119 ___ ### payment\_authorized\_at -• **payment\_authorized\_at**: [`Date`](../modules/internal.md#date) +• **payment\_authorized\_at**: `Date` #### Defined in -packages/medusa/dist/models/cart.d.ts:122 +medusa/dist/models/cart.d.ts:123 ___ @@ -252,7 +264,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:117 +medusa/dist/models/cart.d.ts:118 ___ @@ -262,7 +274,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:115 +medusa/dist/models/cart.d.ts:116 ___ @@ -272,7 +284,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:116 +medusa/dist/models/cart.d.ts:117 ___ @@ -282,7 +294,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:132 +medusa/dist/models/cart.d.ts:135 ___ @@ -292,7 +304,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:129 +medusa/dist/models/cart.d.ts:132 ___ @@ -302,7 +314,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:110 +medusa/dist/models/cart.d.ts:111 ___ @@ -312,7 +324,27 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:109 +medusa/dist/models/cart.d.ts:110 + +___ + +### sales\_channel + +• **sales\_channel**: [`SalesChannel`](internal.SalesChannel.md) + +#### Defined in + +medusa/dist/models/cart.d.ts:128 + +___ + +### sales\_channel\_id + +• **sales\_channel\_id**: ``null`` \| `string` + +#### Defined in + +medusa/dist/models/cart.d.ts:127 ___ @@ -322,7 +354,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:107 +medusa/dist/models/cart.d.ts:108 ___ @@ -332,7 +364,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:106 +medusa/dist/models/cart.d.ts:107 ___ @@ -342,7 +374,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:119 +medusa/dist/models/cart.d.ts:120 ___ @@ -352,7 +384,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:126 +medusa/dist/models/cart.d.ts:129 ___ @@ -362,7 +394,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:131 +medusa/dist/models/cart.d.ts:134 ___ @@ -372,7 +404,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:128 +medusa/dist/models/cart.d.ts:131 ___ @@ -382,7 +414,7 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:130 +medusa/dist/models/cart.d.ts:133 ___ @@ -392,13 +424,13 @@ ___ #### Defined in -packages/medusa/dist/models/cart.d.ts:120 +medusa/dist/models/cart.d.ts:121 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -406,4 +438,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ClaimImage.md b/docs/content/references/js-client/classes/internal.ClaimImage.md index f22cab56b6..49e09f0ce3 100644 --- a/docs/content/references/js-client/classes/internal.ClaimImage.md +++ b/docs/content/references/js-client/classes/internal.ClaimImage.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ClaimImage +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/claim-image.d.ts:8 +medusa/dist/models/claim-image.d.ts:8 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-image.d.ts:5 +medusa/dist/models/claim-image.d.ts:5 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/claim-image.d.ts:4 +medusa/dist/models/claim-image.d.ts:4 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,13 +56,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 +70,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,23 +84,23 @@ ___ #### 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/claim-image.d.ts:7 +medusa/dist/models/claim-image.d.ts:7 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -106,7 +108,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -116,4 +118,4 @@ ___ #### Defined in -packages/medusa/dist/models/claim-image.d.ts:6 +medusa/dist/models/claim-image.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal.ClaimItem.md b/docs/content/references/js-client/classes/internal.ClaimItem.md index ed2ce4e8b5..033ae0d869 100644 --- a/docs/content/references/js-client/classes/internal.ClaimItem.md +++ b/docs/content/references/js-client/classes/internal.ClaimItem.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ClaimItem +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/claim-item.d.ts:26 +medusa/dist/models/claim-item.d.ts:26 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:16 +medusa/dist/models/claim-item.d.ts:16 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:15 +medusa/dist/models/claim-item.d.ts:15 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,13 +56,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 +70,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,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:14 +medusa/dist/models/claim-item.d.ts:14 ___ @@ -102,7 +104,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:18 +medusa/dist/models/claim-item.d.ts:18 ___ @@ -112,17 +114,17 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:17 +medusa/dist/models/claim-item.d.ts:17 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/claim-item.d.ts:25 +medusa/dist/models/claim-item.d.ts:25 ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:22 +medusa/dist/models/claim-item.d.ts:22 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:23 +medusa/dist/models/claim-item.d.ts:23 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:21 +medusa/dist/models/claim-item.d.ts:21 ___ @@ -162,13 +164,13 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:24 +medusa/dist/models/claim-item.d.ts:24 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -176,7 +178,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -186,7 +188,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:20 +medusa/dist/models/claim-item.d.ts:20 ___ @@ -196,4 +198,4 @@ ___ #### Defined in -packages/medusa/dist/models/claim-item.d.ts:19 +medusa/dist/models/claim-item.d.ts:19 diff --git a/docs/content/references/js-client/classes/internal.ClaimOrder.md b/docs/content/references/js-client/classes/internal.ClaimOrder.md index b484e9913c..0e7d6be6fd 100644 --- a/docs/content/references/js-client/classes/internal.ClaimOrder.md +++ b/docs/content/references/js-client/classes/internal.ClaimOrder.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ClaimOrder +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/claim-order.d.ts:33 +medusa/dist/models/claim-order.d.ts:33 ___ @@ -30,17 +32,17 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:50 +medusa/dist/models/claim-order.d.ts:50 ___ ### canceled\_at -• **canceled\_at**: [`Date`](../modules/internal.md#date) +• **canceled\_at**: `Date` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:43 +medusa/dist/models/claim-order.d.ts:43 ___ @@ -50,13 +52,13 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:32 +medusa/dist/models/claim-order.d.ts:32 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Overrides @@ -64,13 +66,13 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:44 +medusa/dist/models/claim-order.d.ts:44 ___ ### deleted\_at -• **deleted\_at**: [`Date`](../modules/internal.md#date) +• **deleted\_at**: `Date` #### Overrides @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:46 +medusa/dist/models/claim-order.d.ts:46 ___ @@ -88,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:31 +medusa/dist/models/claim-order.d.ts:31 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:41 +medusa/dist/models/claim-order.d.ts:41 ___ @@ -112,7 +114,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -122,17 +124,17 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:49 +medusa/dist/models/claim-order.d.ts:49 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/claim-order.d.ts:48 +medusa/dist/models/claim-order.d.ts:48 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:47 +medusa/dist/models/claim-order.d.ts:47 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:36 +medusa/dist/models/claim-order.d.ts:36 ___ @@ -162,7 +164,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:35 +medusa/dist/models/claim-order.d.ts:35 ___ @@ -172,7 +174,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:30 +medusa/dist/models/claim-order.d.ts:30 ___ @@ -182,7 +184,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:42 +medusa/dist/models/claim-order.d.ts:42 ___ @@ -192,7 +194,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:37 +medusa/dist/models/claim-order.d.ts:37 ___ @@ -202,7 +204,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:39 +medusa/dist/models/claim-order.d.ts:39 ___ @@ -212,7 +214,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:38 +medusa/dist/models/claim-order.d.ts:38 ___ @@ -222,7 +224,7 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:40 +medusa/dist/models/claim-order.d.ts:40 ___ @@ -232,13 +234,13 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:34 +medusa/dist/models/claim-order.d.ts:34 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Overrides @@ -246,4 +248,4 @@ ___ #### Defined in -packages/medusa/dist/models/claim-order.d.ts:45 +medusa/dist/models/claim-order.d.ts:45 diff --git a/docs/content/references/js-client/classes/internal.ClaimTag.md b/docs/content/references/js-client/classes/internal.ClaimTag.md index 78c08ba65d..0d283af604 100644 --- a/docs/content/references/js-client/classes/internal.ClaimTag.md +++ b/docs/content/references/js-client/classes/internal.ClaimTag.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ClaimTag +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/claim-tag.d.ts:5 +medusa/dist/models/claim-tag.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -62,23 +64,23 @@ ___ #### 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/claim-tag.d.ts:4 +medusa/dist/models/claim-tag.d.ts:4 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -86,7 +88,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -96,4 +98,4 @@ ___ #### Defined in -packages/medusa/dist/models/claim-tag.d.ts:3 +medusa/dist/models/claim-tag.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.Client.md b/docs/content/references/js-client/classes/internal.Client.md index c639553c93..ccec73e6fa 100644 --- a/docs/content/references/js-client/classes/internal.Client.md +++ b/docs/content/references/js-client/classes/internal.Client.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -[packages/medusa-js/src/request.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L29) +[medusa-js/src/request.ts:29](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L29) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[packages/medusa-js/src/request.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L30) +[medusa-js/src/request.ts:30](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L30) ## Methods @@ -48,7 +48,7 @@ and the exponential backoff approach. #### Defined in -[packages/medusa-js/src/request.ts:146](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L146) +[medusa-js/src/request.ts:146](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L146) ___ @@ -68,13 +68,13 @@ ___ #### Defined in -[packages/medusa-js/src/request.ts:83](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L83) +[medusa-js/src/request.ts:83](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L83) ___ ### normalizeHeaders -▸ **normalizeHeaders**(`obj`): [`Record`](../modules/internal.md#record)<`string`, `any`\> +▸ **normalizeHeaders**(`obj`): `Record`<`string`, `any`\> #### Parameters @@ -84,37 +84,37 @@ ___ #### Returns -[`Record`](../modules/internal.md#record)<`string`, `any`\> +`Record`<`string`, `any`\> #### Defined in -[packages/medusa-js/src/request.ts:71](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L71) +[medusa-js/src/request.ts:71](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L71) ___ ### request -▸ **request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): [`Promise`](../modules/internal.md#promise)<`any`\> +▸ **request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): `Promise`<`any`\> Axios request #### Parameters -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | `undefined` | request method | -| `path` | `string` | `undefined` | request path | -| `payload` | ``null`` \| [`Record`](../modules/internal.md#record)<`string`, `any`\> | `null` | request payload | -| `options` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | `{}` | axios configuration | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | `{}` | custom request headers | +| Name | Type | Description | +| :------ | :------ | :------ | +| `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | request method | +| `path` | `string` | request path | +| `payload` | `Record`<`string`, `any`\> | request payload | +| `options` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | axios configuration | +| `customHeaders` | `Record`<`string`, `any`\> | custom request headers | #### Returns -[`Promise`](../modules/internal.md#promise)<`any`\> +`Promise`<`any`\> #### Defined in -[packages/medusa-js/src/request.ts:183](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L183) +[medusa-js/src/request.ts:183](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L183) ___ @@ -135,7 +135,7 @@ ___ #### Defined in -[packages/medusa-js/src/request.ts:92](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L92) +[medusa-js/src/request.ts:92](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L92) ___ @@ -153,7 +153,7 @@ We add the idempotency key, if the request is configured to retry. | `userHeaders` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | user supplied headers | | `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | request method | | `path` | `string` | request path | -| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | user supplied headers | +| `customHeaders` | `Record`<`string`, `any`\> | user supplied headers | #### Returns @@ -161,7 +161,7 @@ We add the idempotency key, if the request is configured to retry. #### Defined in -[packages/medusa-js/src/request.ts:108](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L108) +[medusa-js/src/request.ts:108](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L108) ___ @@ -183,4 +183,4 @@ ___ #### Defined in -[packages/medusa-js/src/request.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L40) +[medusa-js/src/request.ts:40](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L40) diff --git a/docs/content/references/js-client/classes/internal.Country.md b/docs/content/references/js-client/classes/internal.Country.md index 54f223ca45..acbf228b6e 100644 --- a/docs/content/references/js-client/classes/internal.Country.md +++ b/docs/content/references/js-client/classes/internal.Country.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/country.d.ts:8 +medusa/dist/models/country.d.ts:8 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa/dist/models/country.d.ts:3 +medusa/dist/models/country.d.ts:3 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/medusa/dist/models/country.d.ts:4 +medusa/dist/models/country.d.ts:4 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/medusa/dist/models/country.d.ts:5 +medusa/dist/models/country.d.ts:5 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/medusa/dist/models/country.d.ts:7 +medusa/dist/models/country.d.ts:7 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/medusa/dist/models/country.d.ts:6 +medusa/dist/models/country.d.ts:6 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/models/country.d.ts:10 +medusa/dist/models/country.d.ts:10 ___ @@ -84,4 +84,4 @@ ___ #### Defined in -packages/medusa/dist/models/country.d.ts:9 +medusa/dist/models/country.d.ts:9 diff --git a/docs/content/references/js-client/classes/internal.Currency.md b/docs/content/references/js-client/classes/internal.Currency.md index 7cc9bee20a..ca33db08b7 100644 --- a/docs/content/references/js-client/classes/internal.Currency.md +++ b/docs/content/references/js-client/classes/internal.Currency.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/currency.d.ts:2 +medusa/dist/models/currency.d.ts:2 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa/dist/models/currency.d.ts:5 +medusa/dist/models/currency.d.ts:5 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/medusa/dist/models/currency.d.ts:3 +medusa/dist/models/currency.d.ts:3 ___ @@ -44,4 +44,4 @@ ___ #### Defined in -packages/medusa/dist/models/currency.d.ts:4 +medusa/dist/models/currency.d.ts:4 diff --git a/docs/content/references/js-client/classes/internal.CustomShippingOption.md b/docs/content/references/js-client/classes/internal.CustomShippingOption.md deleted file mode 100644 index b1cbdf55e9..0000000000 --- a/docs/content/references/js-client/classes/internal.CustomShippingOption.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: CustomShippingOption - -[internal](../modules/internal.md).CustomShippingOption - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:107 - -___ - -### price - -• **price**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:108 diff --git a/docs/content/references/js-client/classes/internal.Customer.md b/docs/content/references/js-client/classes/internal.Customer.md index 57747b599a..6d2b70ec95 100644 --- a/docs/content/references/js-client/classes/internal.Customer.md +++ b/docs/content/references/js-client/classes/internal.Customer.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Customer +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/customer.d.ts:18 +medusa/dist/models/customer.d.ts:18 ___ @@ -30,23 +32,23 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:10 +medusa/dist/models/customer.d.ts:10 ___ ### billing\_address\_id -• **billing\_address\_id**: `string` +• **billing\_address\_id**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/customer.d.ts:9 +medusa/dist/models/customer.d.ts:9 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,13 +56,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 +70,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:6 +medusa/dist/models/customer.d.ts:6 ___ @@ -88,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:7 +medusa/dist/models/customer.d.ts:7 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:16 +medusa/dist/models/customer.d.ts:16 ___ @@ -108,7 +110,7 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:14 +medusa/dist/models/customer.d.ts:14 ___ @@ -122,7 +124,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -132,17 +134,17 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:8 +medusa/dist/models/customer.d.ts:8 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/customer.d.ts:17 +medusa/dist/models/customer.d.ts:17 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:15 +medusa/dist/models/customer.d.ts:15 ___ @@ -162,7 +164,7 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:12 +medusa/dist/models/customer.d.ts:12 ___ @@ -172,7 +174,7 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:13 +medusa/dist/models/customer.d.ts:13 ___ @@ -182,13 +184,13 @@ ___ #### Defined in -packages/medusa/dist/models/customer.d.ts:11 +medusa/dist/models/customer.d.ts:11 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -196,4 +198,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.CustomerGroup.md b/docs/content/references/js-client/classes/internal.CustomerGroup.md index 32732baa61..d9764fce5e 100644 --- a/docs/content/references/js-client/classes/internal.CustomerGroup.md +++ b/docs/content/references/js-client/classes/internal.CustomerGroup.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).CustomerGroup +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/customer-group.d.ts:9 +medusa/dist/models/customer-group.d.ts:9 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,7 +36,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -44,13 +46,13 @@ ___ #### Defined in -packages/medusa/dist/models/customer-group.d.ts:6 +medusa/dist/models/customer-group.d.ts:6 ___ ### deleted\_at -• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **deleted\_at**: ``null`` \| `Date` #### Inherited from @@ -58,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -72,17 +74,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/customer-group.d.ts:8 +medusa/dist/models/customer-group.d.ts:8 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/models/customer-group.d.ts:5 +medusa/dist/models/customer-group.d.ts:5 ___ @@ -102,13 +104,13 @@ ___ #### Defined in -packages/medusa/dist/models/customer-group.d.ts:7 +medusa/dist/models/customer-group.d.ts:7 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -116,4 +118,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.CustomerGroupsBatchCustomer.md b/docs/content/references/js-client/classes/internal.CustomerGroupsBatchCustomer.md deleted file mode 100644 index 3f64abb928..0000000000 --- a/docs/content/references/js-client/classes/internal.CustomerGroupsBatchCustomer.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: CustomerGroupsBatchCustomer - -[internal](../modules/internal.md).CustomerGroupsBatchCustomer - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:10 diff --git a/docs/content/references/js-client/classes/internal.DateComparisonOperator.md b/docs/content/references/js-client/classes/internal.DateComparisonOperator.md deleted file mode 100644 index baa39f0110..0000000000 --- a/docs/content/references/js-client/classes/internal.DateComparisonOperator.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: DateComparisonOperator - -[internal](../modules/internal.md).DateComparisonOperator - -## Properties - -### gt - -• `Optional` **gt**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:46 - -___ - -### gte - -• `Optional` **gte**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:47 - -___ - -### lt - -• `Optional` **lt**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:45 - -___ - -### lte - -• `Optional` **lte**: [`Date`](../modules/internal.md#date) - -#### Defined in - -packages/medusa/dist/types/common.d.ts:48 diff --git a/docs/content/references/js-client/classes/internal.Discount.md b/docs/content/references/js-client/classes/internal.Discount.md index 18eab4c2a5..d411d7f375 100644 --- a/docs/content/references/js-client/classes/internal.Discount.md +++ b/docs/content/references/js-client/classes/internal.Discount.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Discount +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/discount.d.ts:5 +medusa/dist/models/discount.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,17 +50,17 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ ### ends\_at -• **ends\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **ends\_at**: ``null`` \| `Date` #### Defined in -packages/medusa/dist/models/discount.d.ts:13 +medusa/dist/models/discount.d.ts:13 ___ @@ -72,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -82,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:9 +medusa/dist/models/discount.d.ts:9 ___ @@ -92,17 +94,17 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:6 +medusa/dist/models/discount.d.ts:6 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/discount.d.ts:18 +medusa/dist/models/discount.d.ts:18 ___ @@ -112,7 +114,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:11 +medusa/dist/models/discount.d.ts:11 ___ @@ -122,7 +124,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:10 +medusa/dist/models/discount.d.ts:10 ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:15 +medusa/dist/models/discount.d.ts:15 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:8 +medusa/dist/models/discount.d.ts:8 ___ @@ -152,23 +154,23 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:7 +medusa/dist/models/discount.d.ts:7 ___ ### starts\_at -• **starts\_at**: [`Date`](../modules/internal.md#date) +• **starts\_at**: `Date` #### Defined in -packages/medusa/dist/models/discount.d.ts:12 +medusa/dist/models/discount.d.ts:12 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -176,7 +178,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -186,7 +188,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:19 +medusa/dist/models/discount.d.ts:19 ___ @@ -196,7 +198,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:17 +medusa/dist/models/discount.d.ts:17 ___ @@ -206,7 +208,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:16 +medusa/dist/models/discount.d.ts:16 ___ @@ -216,4 +218,4 @@ ___ #### Defined in -packages/medusa/dist/models/discount.d.ts:14 +medusa/dist/models/discount.d.ts:14 diff --git a/docs/content/references/js-client/classes/internal.DiscountCondition.md b/docs/content/references/js-client/classes/internal.DiscountCondition.md index 355d626346..13de1a42dc 100644 --- a/docs/content/references/js-client/classes/internal.DiscountCondition.md +++ b/docs/content/references/js-client/classes/internal.DiscountCondition.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).DiscountCondition +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:30 +medusa/dist/models/discount-condition.d.ts:30 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,7 +36,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -44,13 +46,13 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:28 +medusa/dist/models/discount-condition.d.ts:28 ___ ### deleted\_at -• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **deleted\_at**: ``null`` \| `Date` #### Inherited from @@ -58,7 +60,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 +70,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:23 +medusa/dist/models/discount-condition.d.ts:23 ___ @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:22 +medusa/dist/models/discount-condition.d.ts:22 ___ @@ -92,17 +94,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/discount-condition.d.ts:29 +medusa/dist/models/discount-condition.d.ts:29 ___ @@ -112,7 +114,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:21 +medusa/dist/models/discount-condition.d.ts:21 ___ @@ -122,7 +124,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:27 +medusa/dist/models/discount-condition.d.ts:27 ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:26 +medusa/dist/models/discount-condition.d.ts:26 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:25 +medusa/dist/models/discount-condition.d.ts:25 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:24 +medusa/dist/models/discount-condition.d.ts:24 ___ @@ -162,13 +164,13 @@ ___ #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:20 +medusa/dist/models/discount-condition.d.ts:20 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -176,4 +178,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.DiscountRule.md b/docs/content/references/js-client/classes/internal.DiscountRule.md index 7c3e9aee75..964c1d6d91 100644 --- a/docs/content/references/js-client/classes/internal.DiscountRule.md +++ b/docs/content/references/js-client/classes/internal.DiscountRule.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).DiscountRule +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:16 +medusa/dist/models/discount-rule.d.ts:16 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:19 +medusa/dist/models/discount-rule.d.ts:19 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:17 +medusa/dist/models/discount-rule.d.ts:17 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,13 +56,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 +70,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:13 +medusa/dist/models/discount-rule.d.ts:13 ___ @@ -92,17 +94,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/discount-rule.d.ts:18 +medusa/dist/models/discount-rule.d.ts:18 ___ @@ -112,13 +114,13 @@ ___ #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:14 +medusa/dist/models/discount-rule.d.ts:14 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -126,7 +128,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -136,4 +138,4 @@ ___ #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:15 +medusa/dist/models/discount-rule.d.ts:15 diff --git a/docs/content/references/js-client/classes/internal.DraftOrder.md b/docs/content/references/js-client/classes/internal.DraftOrder.md index d9aecbab6a..83ce445515 100644 --- a/docs/content/references/js-client/classes/internal.DraftOrder.md +++ b/docs/content/references/js-client/classes/internal.DraftOrder.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).DraftOrder +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,17 +22,17 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/draft-order.d.ts:20 +medusa/dist/models/draft-order.d.ts:20 ___ ### canceled\_at -• **canceled\_at**: [`Date`](../modules/internal.md#date) +• **canceled\_at**: `Date` #### Defined in -packages/medusa/dist/models/draft-order.d.ts:15 +medusa/dist/models/draft-order.d.ts:15 ___ @@ -40,7 +42,7 @@ ___ #### Defined in -packages/medusa/dist/models/draft-order.d.ts:12 +medusa/dist/models/draft-order.d.ts:12 ___ @@ -50,23 +52,23 @@ ___ #### Defined in -packages/medusa/dist/models/draft-order.d.ts:11 +medusa/dist/models/draft-order.d.ts:11 ___ ### completed\_at -• **completed\_at**: [`Date`](../modules/internal.md#date) +• **completed\_at**: `Date` #### Defined in -packages/medusa/dist/models/draft-order.d.ts:16 +medusa/dist/models/draft-order.d.ts:16 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -74,7 +76,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -84,7 +86,7 @@ ___ #### Defined in -packages/medusa/dist/models/draft-order.d.ts:10 +medusa/dist/models/draft-order.d.ts:10 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -108,17 +110,17 @@ ___ #### Defined in -packages/medusa/dist/models/draft-order.d.ts:19 +medusa/dist/models/draft-order.d.ts:19 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/draft-order.d.ts:18 +medusa/dist/models/draft-order.d.ts:18 ___ @@ -128,7 +130,7 @@ ___ #### Defined in -packages/medusa/dist/models/draft-order.d.ts:17 +medusa/dist/models/draft-order.d.ts:17 ___ @@ -138,7 +140,7 @@ ___ #### Defined in -packages/medusa/dist/models/draft-order.d.ts:14 +medusa/dist/models/draft-order.d.ts:14 ___ @@ -148,7 +150,7 @@ ___ #### Defined in -packages/medusa/dist/models/draft-order.d.ts:13 +medusa/dist/models/draft-order.d.ts:13 ___ @@ -158,13 +160,13 @@ ___ #### Defined in -packages/medusa/dist/models/draft-order.d.ts:9 +medusa/dist/models/draft-order.d.ts:9 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -172,4 +174,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.FilterableCustomerGroupProps.md b/docs/content/references/js-client/classes/internal.FilterableCustomerGroupProps.md deleted file mode 100644 index 41bde548f8..0000000000 --- a/docs/content/references/js-client/classes/internal.FilterableCustomerGroupProps.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FilterableCustomerGroupProps - -[internal](../modules/internal.md).FilterableCustomerGroupProps - -## Hierarchy - -- **`FilterableCustomerGroupProps`** - - ↳ [`AdminGetCustomerGroupsParams`](internal.AdminGetCustomerGroupsParams.md) - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:7 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:3 - -___ - -### name - -• `Optional` **name**: `string`[] - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:5 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:4 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/types/customer-groups.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal.FindParams.md b/docs/content/references/js-client/classes/internal.FindParams.md deleted file mode 100644 index dcacec0518..0000000000 --- a/docs/content/references/js-client/classes/internal.FindParams.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FindParams - -[internal](../modules/internal.md).FindParams - -## Hierarchy - -- **`FindParams`** - - ↳ [`AdminGetCustomerGroupsGroupParams`](internal.AdminGetCustomerGroupsGroupParams.md) - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:89 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/types/common.d.ts:90 diff --git a/docs/content/references/js-client/classes/internal.Fulfillment.md b/docs/content/references/js-client/classes/internal.Fulfillment.md index a3b2468752..f1fa1686d2 100644 --- a/docs/content/references/js-client/classes/internal.Fulfillment.md +++ b/docs/content/references/js-client/classes/internal.Fulfillment.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Fulfillment +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,17 +22,17 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:26 +medusa/dist/models/fulfillment.d.ts:26 ___ ### canceled\_at -• **canceled\_at**: [`Date`](../modules/internal.md#date) +• **canceled\_at**: `Date` #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:23 +medusa/dist/models/fulfillment.d.ts:23 ___ @@ -40,7 +42,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:10 +medusa/dist/models/fulfillment.d.ts:10 ___ @@ -50,13 +52,13 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:9 +medusa/dist/models/fulfillment.d.ts:9 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -64,17 +66,17 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ ### data -• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **data**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:21 +medusa/dist/models/fulfillment.d.ts:21 ___ @@ -88,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:25 +medusa/dist/models/fulfillment.d.ts:25 ___ @@ -108,17 +110,17 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:18 +medusa/dist/models/fulfillment.d.ts:18 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:24 +medusa/dist/models/fulfillment.d.ts:24 ___ @@ -128,7 +130,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:15 +medusa/dist/models/fulfillment.d.ts:15 ___ @@ -138,7 +140,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:14 +medusa/dist/models/fulfillment.d.ts:14 ___ @@ -148,7 +150,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:13 +medusa/dist/models/fulfillment.d.ts:13 ___ @@ -158,7 +160,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:17 +medusa/dist/models/fulfillment.d.ts:17 ___ @@ -168,17 +170,17 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:16 +medusa/dist/models/fulfillment.d.ts:16 ___ ### shipped\_at -• **shipped\_at**: [`Date`](../modules/internal.md#date) +• **shipped\_at**: `Date` #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:22 +medusa/dist/models/fulfillment.d.ts:22 ___ @@ -188,7 +190,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:12 +medusa/dist/models/fulfillment.d.ts:12 ___ @@ -198,7 +200,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:11 +medusa/dist/models/fulfillment.d.ts:11 ___ @@ -208,7 +210,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:19 +medusa/dist/models/fulfillment.d.ts:19 ___ @@ -218,13 +220,13 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment.d.ts:20 +medusa/dist/models/fulfillment.d.ts:20 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -232,4 +234,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.FulfillmentItem.md b/docs/content/references/js-client/classes/internal.FulfillmentItem.md index 9df69a525a..646c5f1fcc 100644 --- a/docs/content/references/js-client/classes/internal.FulfillmentItem.md +++ b/docs/content/references/js-client/classes/internal.FulfillmentItem.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/fulfillment-item.d.ts:6 +medusa/dist/models/fulfillment-item.d.ts:6 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment-item.d.ts:4 +medusa/dist/models/fulfillment-item.d.ts:4 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment-item.d.ts:7 +medusa/dist/models/fulfillment-item.d.ts:7 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment-item.d.ts:5 +medusa/dist/models/fulfillment-item.d.ts:5 ___ @@ -54,4 +54,4 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment-item.d.ts:8 +medusa/dist/models/fulfillment-item.d.ts:8 diff --git a/docs/content/references/js-client/classes/internal.FulfillmentOption.md b/docs/content/references/js-client/classes/internal.FulfillmentOption.md deleted file mode 100644 index c3cd8aed48..0000000000 --- a/docs/content/references/js-client/classes/internal.FulfillmentOption.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FulfillmentOption - -[internal](../modules/internal.md).FulfillmentOption - -## Properties - -### options - -• **options**: `unknown`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/index.d.ts:17 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/regions/index.d.ts:16 diff --git a/docs/content/references/js-client/classes/internal.FulfillmentProvider.md b/docs/content/references/js-client/classes/internal.FulfillmentProvider.md index ce999aa913..26095bd164 100644 --- a/docs/content/references/js-client/classes/internal.FulfillmentProvider.md +++ b/docs/content/references/js-client/classes/internal.FulfillmentProvider.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/fulfillment-provider.d.ts:2 +medusa/dist/models/fulfillment-provider.d.ts:2 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -packages/medusa/dist/models/fulfillment-provider.d.ts:3 +medusa/dist/models/fulfillment-provider.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.GiftCard.md b/docs/content/references/js-client/classes/internal.GiftCard.md index 8ead7e0d41..0d47e9e932 100644 --- a/docs/content/references/js-client/classes/internal.GiftCard.md +++ b/docs/content/references/js-client/classes/internal.GiftCard.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).GiftCard +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/gift-card.d.ts:7 +medusa/dist/models/gift-card.d.ts:7 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card.d.ts:15 +medusa/dist/models/gift-card.d.ts:15 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card.d.ts:5 +medusa/dist/models/gift-card.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,13 +56,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,17 +70,17 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ ### ends\_at -• **ends\_at**: [`Date`](../modules/internal.md#date) +• **ends\_at**: `Date` #### Defined in -packages/medusa/dist/models/gift-card.d.ts:13 +medusa/dist/models/gift-card.d.ts:13 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -102,17 +104,17 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card.d.ts:12 +medusa/dist/models/gift-card.d.ts:12 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/gift-card.d.ts:14 +medusa/dist/models/gift-card.d.ts:14 ___ @@ -122,7 +124,7 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card.d.ts:11 +medusa/dist/models/gift-card.d.ts:11 ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card.d.ts:10 +medusa/dist/models/gift-card.d.ts:10 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card.d.ts:9 +medusa/dist/models/gift-card.d.ts:9 ___ @@ -152,13 +154,13 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card.d.ts:8 +medusa/dist/models/gift-card.d.ts:8 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -166,7 +168,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -176,4 +178,4 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card.d.ts:6 +medusa/dist/models/gift-card.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal.GiftCardTransaction.md b/docs/content/references/js-client/classes/internal.GiftCardTransaction.md index 256f61455b..2922b33fec 100644 --- a/docs/content/references/js-client/classes/internal.GiftCardTransaction.md +++ b/docs/content/references/js-client/classes/internal.GiftCardTransaction.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/gift-card-transaction.d.ts:9 +medusa/dist/models/gift-card-transaction.d.ts:9 ___ @@ -24,17 +24,17 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card-transaction.d.ts:11 +medusa/dist/models/gift-card-transaction.d.ts:13 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Defined in -packages/medusa/dist/models/gift-card-transaction.d.ts:10 +medusa/dist/models/gift-card-transaction.d.ts:10 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card-transaction.d.ts:6 +medusa/dist/models/gift-card-transaction.d.ts:6 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card-transaction.d.ts:5 +medusa/dist/models/gift-card-transaction.d.ts:5 ___ @@ -64,7 +64,17 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card-transaction.d.ts:4 +medusa/dist/models/gift-card-transaction.d.ts:4 + +___ + +### is\_taxable + +• **is\_taxable**: `boolean` + +#### Defined in + +medusa/dist/models/gift-card-transaction.d.ts:11 ___ @@ -74,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card-transaction.d.ts:8 +medusa/dist/models/gift-card-transaction.d.ts:8 ___ @@ -84,4 +94,14 @@ ___ #### Defined in -packages/medusa/dist/models/gift-card-transaction.d.ts:7 +medusa/dist/models/gift-card-transaction.d.ts:7 + +___ + +### tax\_rate + +• **tax\_rate**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/gift-card-transaction.d.ts:12 diff --git a/docs/content/references/js-client/classes/internal.Group.md b/docs/content/references/js-client/classes/internal.Group.md deleted file mode 100644 index 76879655e9..0000000000 --- a/docs/content/references/js-client/classes/internal.Group.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Group - -[internal](../modules/internal.md).Group - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:57 diff --git a/docs/content/references/js-client/classes/internal.IAdminPostUploadsFile.md b/docs/content/references/js-client/classes/internal.IAdminPostUploadsFile.md deleted file mode 100644 index 53ad94c9da..0000000000 --- a/docs/content/references/js-client/classes/internal.IAdminPostUploadsFile.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: IAdminPostUploadsFile - -[internal](../modules/internal.md).IAdminPostUploadsFile - -## Properties - -### originalName - -• **originalName**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/uploads/create-upload.d.ts:21 - -___ - -### path - -• **path**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/uploads/create-upload.d.ts:22 diff --git a/docs/content/references/js-client/classes/internal.Image.md b/docs/content/references/js-client/classes/internal.Image.md index c2de0134f2..32fc6530b3 100644 --- a/docs/content/references/js-client/classes/internal.Image.md +++ b/docs/content/references/js-client/classes/internal.Image.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Image +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/image.d.ts:5 +medusa/dist/models/image.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -62,23 +64,23 @@ ___ #### 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/image.d.ts:4 +medusa/dist/models/image.d.ts:4 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -86,7 +88,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -96,4 +98,4 @@ ___ #### Defined in -packages/medusa/dist/models/image.d.ts:3 +medusa/dist/models/image.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.Item.md b/docs/content/references/js-client/classes/internal.Item.md deleted file mode 100644 index edab2096a2..0000000000 --- a/docs/content/references/js-client/classes/internal.Item.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Item - -[internal](../modules/internal.md).Item - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:53 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal.LineItem.md b/docs/content/references/js-client/classes/internal.LineItem.md index fbfbd01b86..f14ff05164 100644 --- a/docs/content/references/js-client/classes/internal.LineItem.md +++ b/docs/content/references/js-client/classes/internal.LineItem.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).LineItem +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/line-item.d.ts:19 +medusa/dist/models/line-item.d.ts:19 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:26 +medusa/dist/models/line-item.d.ts:26 ___ @@ -40,7 +42,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:37 +medusa/dist/models/line-item.d.ts:44 ___ @@ -50,7 +52,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:11 +medusa/dist/models/line-item.d.ts:11 ___ @@ -60,7 +62,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:10 +medusa/dist/models/line-item.d.ts:10 ___ @@ -70,7 +72,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:17 +medusa/dist/models/line-item.d.ts:17 ___ @@ -80,13 +82,13 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:16 +medusa/dist/models/line-item.d.ts:16 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -94,7 +96,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -104,7 +106,17 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:21 +medusa/dist/models/line-item.d.ts:21 + +___ + +### discount\_total + +• `Optional` **discount\_total**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/line-item.d.ts:42 ___ @@ -114,7 +126,17 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:32 +medusa/dist/models/line-item.d.ts:32 + +___ + +### gift\_card\_total + +• `Optional` **gift\_card\_total**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/line-item.d.ts:43 ___ @@ -124,7 +146,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:27 +medusa/dist/models/line-item.d.ts:27 ___ @@ -138,7 +160,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -148,7 +170,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:24 +medusa/dist/models/line-item.d.ts:24 ___ @@ -158,17 +180,17 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:23 +medusa/dist/models/line-item.d.ts:23 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/line-item.d.ts:35 +medusa/dist/models/line-item.d.ts:35 ___ @@ -178,7 +200,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:13 +medusa/dist/models/line-item.d.ts:13 ___ @@ -188,7 +210,27 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:12 +medusa/dist/models/line-item.d.ts:12 + +___ + +### original\_tax\_total + +• `Optional` **original\_tax\_total**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/line-item.d.ts:41 + +___ + +### original\_total + +• `Optional` **original\_total**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/line-item.d.ts:40 ___ @@ -198,17 +240,17 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:31 +medusa/dist/models/line-item.d.ts:31 ___ ### refundable -• **refundable**: ``null`` \| `number` +• `Optional` **refundable**: ``null`` \| `number` #### Defined in -packages/medusa/dist/models/line-item.d.ts:36 +medusa/dist/models/line-item.d.ts:36 ___ @@ -218,7 +260,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:33 +medusa/dist/models/line-item.d.ts:33 ___ @@ -228,7 +270,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:34 +medusa/dist/models/line-item.d.ts:34 ___ @@ -238,7 +280,17 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:25 +medusa/dist/models/line-item.d.ts:25 + +___ + +### subtotal + +• `Optional` **subtotal**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/line-item.d.ts:37 ___ @@ -248,7 +300,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:15 +medusa/dist/models/line-item.d.ts:15 ___ @@ -258,7 +310,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:14 +medusa/dist/models/line-item.d.ts:14 ___ @@ -268,17 +320,27 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:18 +medusa/dist/models/line-item.d.ts:18 + +___ + +### tax\_total + +• `Optional` **tax\_total**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/line-item.d.ts:38 ___ ### thumbnail -• **thumbnail**: `string` +• **thumbnail**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/line-item.d.ts:22 +medusa/dist/models/line-item.d.ts:22 ___ @@ -288,7 +350,17 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:20 +medusa/dist/models/line-item.d.ts:20 + +___ + +### total + +• `Optional` **total**: ``null`` \| `number` + +#### Defined in + +medusa/dist/models/line-item.d.ts:39 ___ @@ -298,13 +370,13 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:28 +medusa/dist/models/line-item.d.ts:28 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -312,7 +384,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -322,7 +394,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:30 +medusa/dist/models/line-item.d.ts:30 ___ @@ -332,4 +404,4 @@ ___ #### Defined in -packages/medusa/dist/models/line-item.d.ts:29 +medusa/dist/models/line-item.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal.LineItemAdjustment.md b/docs/content/references/js-client/classes/internal.LineItemAdjustment.md index e4256ccd57..9e5d1cd55c 100644 --- a/docs/content/references/js-client/classes/internal.LineItemAdjustment.md +++ b/docs/content/references/js-client/classes/internal.LineItemAdjustment.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:10 +medusa/dist/models/line-item-adjustment.d.ts:10 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:12 +medusa/dist/models/line-item-adjustment.d.ts:12 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:7 +medusa/dist/models/line-item-adjustment.d.ts:7 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:8 +medusa/dist/models/line-item-adjustment.d.ts:8 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:9 +medusa/dist/models/line-item-adjustment.d.ts:9 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:4 +medusa/dist/models/line-item-adjustment.d.ts:4 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:6 +medusa/dist/models/line-item-adjustment.d.ts:6 ___ @@ -84,14 +84,14 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:5 +medusa/dist/models/line-item-adjustment.d.ts:5 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/line-item-adjustment.d.ts:11 +medusa/dist/models/line-item-adjustment.d.ts:11 diff --git a/docs/content/references/js-client/classes/internal.LineItemTaxLine.md b/docs/content/references/js-client/classes/internal.LineItemTaxLine.md index 362531d4db..35adc8adfa 100644 --- a/docs/content/references/js-client/classes/internal.LineItemTaxLine.md +++ b/docs/content/references/js-client/classes/internal.LineItemTaxLine.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).LineItemTaxLine +Base abstract entity for all entities + ## Hierarchy - [`TaxLine`](internal.TaxLine.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/line-item-tax-line.d.ts:6 +medusa/dist/models/line-item-tax-line.d.ts:6 ___ @@ -34,13 +36,13 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:5 +medusa/dist/models/tax-line.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -62,7 +64,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -72,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-tax-line.d.ts:5 +medusa/dist/models/line-item-tax-line.d.ts:5 ___ @@ -82,13 +84,13 @@ ___ #### Defined in -packages/medusa/dist/models/line-item-tax-line.d.ts:4 +medusa/dist/models/line-item-tax-line.d.ts:4 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Inherited from @@ -96,7 +98,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:6 +medusa/dist/models/tax-line.d.ts:6 ___ @@ -110,7 +112,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:4 +medusa/dist/models/tax-line.d.ts:4 ___ @@ -124,13 +126,13 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:3 +medusa/dist/models/tax-line.d.ts:3 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -138,4 +140,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.MoneyAmount.md b/docs/content/references/js-client/classes/internal.MoneyAmount.md index e53dd977e1..82eaf5b4d7 100644 --- a/docs/content/references/js-client/classes/internal.MoneyAmount.md +++ b/docs/content/references/js-client/classes/internal.MoneyAmount.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).MoneyAmount +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/money-amount.d.ts:9 +medusa/dist/models/money-amount.d.ts:9 ___ @@ -30,13 +32,13 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:18 +medusa/dist/models/money-amount.d.ts:18 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -44,7 +46,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -54,7 +56,7 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:8 +medusa/dist/models/money-amount.d.ts:8 ___ @@ -64,13 +66,13 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:7 +medusa/dist/models/money-amount.d.ts:7 ___ ### deleted\_at -• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **deleted\_at**: ``null`` \| `Date` #### Inherited from @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -102,7 +104,7 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:11 +medusa/dist/models/money-amount.d.ts:11 ___ @@ -112,7 +114,7 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:10 +medusa/dist/models/money-amount.d.ts:10 ___ @@ -122,7 +124,7 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:13 +medusa/dist/models/money-amount.d.ts:13 ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:12 +medusa/dist/models/money-amount.d.ts:12 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:17 +medusa/dist/models/money-amount.d.ts:17 ___ @@ -152,13 +154,13 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:16 +medusa/dist/models/money-amount.d.ts:16 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -166,7 +168,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -176,7 +178,7 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:15 +medusa/dist/models/money-amount.d.ts:15 ___ @@ -186,4 +188,4 @@ ___ #### Defined in -packages/medusa/dist/models/money-amount.d.ts:14 +medusa/dist/models/money-amount.d.ts:14 diff --git a/docs/content/references/js-client/classes/internal.NotificationProvider.md b/docs/content/references/js-client/classes/internal.NotificationProvider.md deleted file mode 100644 index 174b8384aa..0000000000 --- a/docs/content/references/js-client/classes/internal.NotificationProvider.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: NotificationProvider - -[internal](../modules/internal.md).NotificationProvider - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -packages/medusa/dist/models/notification-provider.d.ts:2 - -___ - -### is\_installed - -• **is\_installed**: `boolean` - -#### Defined in - -packages/medusa/dist/models/notification-provider.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.OptionRequirement.md b/docs/content/references/js-client/classes/internal.OptionRequirement.md deleted file mode 100644 index 7ec23ae4c1..0000000000 --- a/docs/content/references/js-client/classes/internal.OptionRequirement.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: OptionRequirement - -[internal](../modules/internal.md).OptionRequirement - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:75 - -___ - -### type - -• **type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:74 diff --git a/docs/content/references/js-client/classes/internal.Order.md b/docs/content/references/js-client/classes/internal.Order.md index 09bb769f00..dda9f663a0 100644 --- a/docs/content/references/js-client/classes/internal.Order.md +++ b/docs/content/references/js-client/classes/internal.Order.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Order +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/order.d.ts:93 +medusa/dist/models/order.d.ts:97 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:58 +medusa/dist/models/order.d.ts:59 ___ @@ -40,17 +42,17 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:57 +medusa/dist/models/order.d.ts:58 ___ ### canceled\_at -• **canceled\_at**: [`Date`](../modules/internal.md#date) +• **canceled\_at**: `Date` #### Defined in -packages/medusa/dist/models/order.d.ts:79 +medusa/dist/models/order.d.ts:80 ___ @@ -60,7 +62,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:53 +medusa/dist/models/order.d.ts:54 ___ @@ -70,7 +72,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:52 +medusa/dist/models/order.d.ts:53 ___ @@ -80,13 +82,13 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:72 +medusa/dist/models/order.d.ts:73 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -94,7 +96,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -104,7 +106,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:64 +medusa/dist/models/order.d.ts:65 ___ @@ -114,7 +116,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:63 +medusa/dist/models/order.d.ts:64 ___ @@ -124,7 +126,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:55 +medusa/dist/models/order.d.ts:56 ___ @@ -134,7 +136,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:54 +medusa/dist/models/order.d.ts:55 ___ @@ -144,7 +146,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:85 +medusa/dist/models/order.d.ts:88 ___ @@ -154,7 +156,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:66 +medusa/dist/models/order.d.ts:67 ___ @@ -164,7 +166,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:51 +medusa/dist/models/order.d.ts:52 ___ @@ -174,7 +176,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:76 +medusa/dist/models/order.d.ts:77 ___ @@ -184,7 +186,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:75 +medusa/dist/models/order.d.ts:76 ___ @@ -194,7 +196,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:56 +medusa/dist/models/order.d.ts:57 ___ @@ -204,7 +206,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:83 +medusa/dist/models/order.d.ts:84 ___ @@ -214,7 +216,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:49 +medusa/dist/models/order.d.ts:50 ___ @@ -224,7 +226,17 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:70 +medusa/dist/models/order.d.ts:71 + +___ + +### gift\_card\_tax\_total + +• **gift\_card\_tax\_total**: `number` + +#### Defined in + +medusa/dist/models/order.d.ts:96 ___ @@ -234,7 +246,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:92 +medusa/dist/models/order.d.ts:95 ___ @@ -244,7 +256,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:78 +medusa/dist/models/order.d.ts:79 ___ @@ -254,7 +266,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:67 +medusa/dist/models/order.d.ts:68 ___ @@ -268,7 +280,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -278,7 +290,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:82 +medusa/dist/models/order.d.ts:83 ___ @@ -288,17 +300,17 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:77 +medusa/dist/models/order.d.ts:78 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/order.d.ts:80 +medusa/dist/models/order.d.ts:81 ___ @@ -308,7 +320,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:81 +medusa/dist/models/order.d.ts:82 ___ @@ -318,7 +330,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:47 +medusa/dist/models/order.d.ts:48 ___ @@ -328,7 +340,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:90 +medusa/dist/models/order.d.ts:93 ___ @@ -338,7 +350,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:50 +medusa/dist/models/order.d.ts:51 ___ @@ -348,7 +360,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:69 +medusa/dist/models/order.d.ts:70 ___ @@ -358,7 +370,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:91 +medusa/dist/models/order.d.ts:94 ___ @@ -368,7 +380,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:87 +medusa/dist/models/order.d.ts:90 ___ @@ -378,7 +390,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:73 +medusa/dist/models/order.d.ts:74 ___ @@ -388,7 +400,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:62 +medusa/dist/models/order.d.ts:63 ___ @@ -398,7 +410,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:61 +medusa/dist/models/order.d.ts:62 ___ @@ -408,7 +420,27 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:71 +medusa/dist/models/order.d.ts:72 + +___ + +### sales\_channel + +• **sales\_channel**: [`SalesChannel`](internal.SalesChannel.md) + +#### Defined in + +medusa/dist/models/order.d.ts:86 + +___ + +### sales\_channel\_id + +• **sales\_channel\_id**: ``null`` \| `string` + +#### Defined in + +medusa/dist/models/order.d.ts:85 ___ @@ -418,7 +450,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:60 +medusa/dist/models/order.d.ts:61 ___ @@ -428,7 +460,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:59 +medusa/dist/models/order.d.ts:60 ___ @@ -438,7 +470,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:68 +medusa/dist/models/order.d.ts:69 ___ @@ -448,7 +480,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:84 +medusa/dist/models/order.d.ts:87 ___ @@ -458,7 +490,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:48 +medusa/dist/models/order.d.ts:49 ___ @@ -468,7 +500,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:89 +medusa/dist/models/order.d.ts:92 ___ @@ -478,7 +510,7 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:74 +medusa/dist/models/order.d.ts:75 ___ @@ -488,17 +520,17 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:65 +medusa/dist/models/order.d.ts:66 ___ ### tax\_total -• **tax\_total**: `number` +• **tax\_total**: ``null`` \| `number` #### Defined in -packages/medusa/dist/models/order.d.ts:86 +medusa/dist/models/order.d.ts:89 ___ @@ -508,13 +540,13 @@ ___ #### Defined in -packages/medusa/dist/models/order.d.ts:88 +medusa/dist/models/order.d.ts:91 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -522,4 +554,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.Payment.md b/docs/content/references/js-client/classes/internal.Payment.md index 68eccfb319..305900e8db 100644 --- a/docs/content/references/js-client/classes/internal.Payment.md +++ b/docs/content/references/js-client/classes/internal.Payment.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Payment +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/payment.d.ts:13 +medusa/dist/models/payment.d.ts:13 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:16 +medusa/dist/models/payment.d.ts:16 ___ @@ -40,27 +42,27 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:23 +medusa/dist/models/payment.d.ts:23 ___ ### canceled\_at -• **canceled\_at**: [`Date`](../modules/internal.md#date) +• **canceled\_at**: `Date` #### Defined in -packages/medusa/dist/models/payment.d.ts:20 +medusa/dist/models/payment.d.ts:20 ___ ### captured\_at -• **captured\_at**: [`Date`](../modules/internal.md#date) +• **captured\_at**: `Date` #### Defined in -packages/medusa/dist/models/payment.d.ts:19 +medusa/dist/models/payment.d.ts:19 ___ @@ -70,7 +72,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:10 +medusa/dist/models/payment.d.ts:10 ___ @@ -80,13 +82,13 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:9 +medusa/dist/models/payment.d.ts:9 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -94,7 +96,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -104,7 +106,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:15 +medusa/dist/models/payment.d.ts:15 ___ @@ -114,17 +116,17 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:14 +medusa/dist/models/payment.d.ts:14 ___ ### data -• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **data**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/payment.d.ts:18 +medusa/dist/models/payment.d.ts:18 ___ @@ -138,7 +140,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -148,17 +150,17 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:22 +medusa/dist/models/payment.d.ts:22 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/payment.d.ts:21 +medusa/dist/models/payment.d.ts:21 ___ @@ -168,7 +170,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:12 +medusa/dist/models/payment.d.ts:12 ___ @@ -178,7 +180,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:11 +medusa/dist/models/payment.d.ts:11 ___ @@ -188,7 +190,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:17 +medusa/dist/models/payment.d.ts:17 ___ @@ -198,7 +200,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:8 +medusa/dist/models/payment.d.ts:8 ___ @@ -208,13 +210,13 @@ ___ #### Defined in -packages/medusa/dist/models/payment.d.ts:7 +medusa/dist/models/payment.d.ts:7 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -222,4 +224,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.PaymentMethod.md b/docs/content/references/js-client/classes/internal.PaymentMethod.md deleted file mode 100644 index 4c7ff89d97..0000000000 --- a/docs/content/references/js-client/classes/internal.PaymentMethod.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: PaymentMethod - -[internal](../modules/internal.md).PaymentMethod - -## Properties - -### data - -• `Optional` **data**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:115 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/create-order.d.ts:114 diff --git a/docs/content/references/js-client/classes/internal.PaymentProvider.md b/docs/content/references/js-client/classes/internal.PaymentProvider.md index 3bc820d86a..5a0f19fe55 100644 --- a/docs/content/references/js-client/classes/internal.PaymentProvider.md +++ b/docs/content/references/js-client/classes/internal.PaymentProvider.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/payment-provider.d.ts:2 +medusa/dist/models/payment-provider.d.ts:2 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -packages/medusa/dist/models/payment-provider.d.ts:3 +medusa/dist/models/payment-provider.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.PaymentSession.md b/docs/content/references/js-client/classes/internal.PaymentSession.md index ac4f453bda..c67f419aa1 100644 --- a/docs/content/references/js-client/classes/internal.PaymentSession.md +++ b/docs/content/references/js-client/classes/internal.PaymentSession.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).PaymentSession +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/payment-session.d.ts:18 +medusa/dist/models/payment-session.d.ts:18 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment-session.d.ts:12 +medusa/dist/models/payment-session.d.ts:12 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/payment-session.d.ts:11 +medusa/dist/models/payment-session.d.ts:11 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,17 +56,17 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ ### data -• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **data**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/payment-session.d.ts:16 +medusa/dist/models/payment-session.d.ts:16 ___ @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -88,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment-session.d.ts:17 +medusa/dist/models/payment-session.d.ts:17 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment-session.d.ts:14 +medusa/dist/models/payment-session.d.ts:14 ___ @@ -108,7 +110,7 @@ ___ #### Defined in -packages/medusa/dist/models/payment-session.d.ts:13 +medusa/dist/models/payment-session.d.ts:13 ___ @@ -118,13 +120,13 @@ ___ #### Defined in -packages/medusa/dist/models/payment-session.d.ts:15 +medusa/dist/models/payment-session.d.ts:15 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -132,4 +134,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.PriceList.md b/docs/content/references/js-client/classes/internal.PriceList.md index d54f3acd24..32330b63fd 100644 --- a/docs/content/references/js-client/classes/internal.PriceList.md +++ b/docs/content/references/js-client/classes/internal.PriceList.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).PriceList +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/price-list.d.ts:14 +medusa/dist/models/price-list.d.ts:14 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,7 +36,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -44,13 +46,13 @@ ___ #### Defined in -packages/medusa/dist/models/price-list.d.ts:12 +medusa/dist/models/price-list.d.ts:12 ___ ### deleted\_at -• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **deleted\_at**: ``null`` \| `Date` #### Inherited from @@ -58,7 +60,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,17 +70,17 @@ ___ #### Defined in -packages/medusa/dist/models/price-list.d.ts:7 +medusa/dist/models/price-list.d.ts:7 ___ ### ends\_at -• **ends\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **ends\_at**: ``null`` \| `Date` #### Defined in -packages/medusa/dist/models/price-list.d.ts:11 +medusa/dist/models/price-list.d.ts:11 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -102,7 +104,7 @@ ___ #### Defined in -packages/medusa/dist/models/price-list.d.ts:6 +medusa/dist/models/price-list.d.ts:6 ___ @@ -112,17 +114,17 @@ ___ #### Defined in -packages/medusa/dist/models/price-list.d.ts:13 +medusa/dist/models/price-list.d.ts:13 ___ ### starts\_at -• **starts\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **starts\_at**: ``null`` \| `Date` #### Defined in -packages/medusa/dist/models/price-list.d.ts:10 +medusa/dist/models/price-list.d.ts:10 ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/price-list.d.ts:9 +medusa/dist/models/price-list.d.ts:9 ___ @@ -142,13 +144,13 @@ ___ #### Defined in -packages/medusa/dist/models/price-list.d.ts:8 +medusa/dist/models/price-list.d.ts:8 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -156,4 +158,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.PriceSelectionParams.md b/docs/content/references/js-client/classes/internal.PriceSelectionParams.md deleted file mode 100644 index 48b3ce2aa2..0000000000 --- a/docs/content/references/js-client/classes/internal.PriceSelectionParams.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: PriceSelectionParams - -[internal](../modules/internal.md).PriceSelectionParams - -## Hierarchy - -- **`PriceSelectionParams`** - - ↳ [`StoreGetVariantsParams`](internal.StoreGetVariantsParams.md) - - ↳ [`StoreGetProductsPaginationParams`](internal.StoreGetProductsPaginationParams.md) - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:2 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:4 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.Product.md b/docs/content/references/js-client/classes/internal.Product.md index 1515b912ca..f1248fa83c 100644 --- a/docs/content/references/js-client/classes/internal.Product.md +++ b/docs/content/references/js-client/classes/internal.Product.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Product +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/product.d.ts:44 +medusa/dist/models/product.d.ts:46 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:37 +medusa/dist/models/product.d.ts:38 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:36 +medusa/dist/models/product.d.ts:37 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,13 +56,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,17 +70,17 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ ### description -• **description**: `string` +• **description**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:18 +medusa/dist/models/product.d.ts:19 ___ @@ -88,47 +90,47 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:41 +medusa/dist/models/product.d.ts:42 ___ ### external\_id -• **external\_id**: `string` +• **external\_id**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:42 +medusa/dist/models/product.d.ts:43 ___ ### handle -• **handle**: `string` +• **handle**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:19 +medusa/dist/models/product.d.ts:20 ___ ### height -• **height**: `number` +• **height**: ``null`` \| `number` #### Defined in -packages/medusa/dist/models/product.d.ts:30 +medusa/dist/models/product.d.ts:31 ___ ### hs\_code -• **hs\_code**: `string` +• **hs\_code**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:32 +medusa/dist/models/product.d.ts:33 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:22 +medusa/dist/models/product.d.ts:23 ___ @@ -162,47 +164,47 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:20 +medusa/dist/models/product.d.ts:21 ___ ### length -• **length**: `number` +• **length**: ``null`` \| `number` #### Defined in -packages/medusa/dist/models/product.d.ts:29 +medusa/dist/models/product.d.ts:30 ___ ### material -• **material**: `string` +• **material**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:35 +medusa/dist/models/product.d.ts:36 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: ``null`` \| `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/product.d.ts:43 +medusa/dist/models/product.d.ts:44 ___ ### mid\_code -• **mid\_code**: `string` +• **mid\_code**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:34 +medusa/dist/models/product.d.ts:35 ___ @@ -212,17 +214,17 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:24 +medusa/dist/models/product.d.ts:25 ___ ### origin\_country -• **origin\_country**: `string` +• **origin\_country**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:33 +medusa/dist/models/product.d.ts:34 ___ @@ -232,7 +234,7 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:27 +medusa/dist/models/product.d.ts:28 ___ @@ -242,27 +244,37 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:26 +medusa/dist/models/product.d.ts:27 + +___ + +### sales\_channels + +• **sales\_channels**: [`SalesChannel`](internal.SalesChannel.md)[] + +#### Defined in + +medusa/dist/models/product.d.ts:45 ___ ### status -• **status**: [`Status`](../enums/internal.Status.md) +• **status**: [`ProductStatus`](../enums/internal.ProductStatus.md) #### Defined in -packages/medusa/dist/models/product.d.ts:21 +medusa/dist/models/product.d.ts:22 ___ ### subtitle -• **subtitle**: `string` +• **subtitle**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:17 +medusa/dist/models/product.d.ts:18 ___ @@ -272,17 +284,17 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:40 +medusa/dist/models/product.d.ts:41 ___ ### thumbnail -• **thumbnail**: `string` +• **thumbnail**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:23 +medusa/dist/models/product.d.ts:24 ___ @@ -292,7 +304,7 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:16 +medusa/dist/models/product.d.ts:17 ___ @@ -302,23 +314,23 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:39 +medusa/dist/models/product.d.ts:40 ___ ### type\_id -• **type\_id**: `string` +• **type\_id**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/product.d.ts:38 +medusa/dist/models/product.d.ts:39 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -326,7 +338,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -336,24 +348,24 @@ ___ #### Defined in -packages/medusa/dist/models/product.d.ts:25 +medusa/dist/models/product.d.ts:26 ___ ### weight -• **weight**: `number` +• **weight**: ``null`` \| `number` #### Defined in -packages/medusa/dist/models/product.d.ts:28 +medusa/dist/models/product.d.ts:29 ___ ### width -• **width**: `number` +• **width**: ``null`` \| `number` #### Defined in -packages/medusa/dist/models/product.d.ts:31 +medusa/dist/models/product.d.ts:32 diff --git a/docs/content/references/js-client/classes/internal.ProductCollection.md b/docs/content/references/js-client/classes/internal.ProductCollection.md index b046d1523d..e2b187687f 100644 --- a/docs/content/references/js-client/classes/internal.ProductCollection.md +++ b/docs/content/references/js-client/classes/internal.ProductCollection.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ProductCollection +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/product-collection.d.ts:8 +medusa/dist/models/product-collection.d.ts:8 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -58,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-collection.d.ts:5 +medusa/dist/models/product-collection.d.ts:5 ___ @@ -72,17 +74,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/product-collection.d.ts:7 +medusa/dist/models/product-collection.d.ts:7 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-collection.d.ts:6 +medusa/dist/models/product-collection.d.ts:6 ___ @@ -102,13 +104,13 @@ ___ #### Defined in -packages/medusa/dist/models/product-collection.d.ts:4 +medusa/dist/models/product-collection.d.ts:4 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -116,4 +118,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ProductOption.md b/docs/content/references/js-client/classes/internal.ProductOption.md index 212ddada62..df3d619083 100644 --- a/docs/content/references/js-client/classes/internal.ProductOption.md +++ b/docs/content/references/js-client/classes/internal.ProductOption.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ProductOption +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/product-option.d.ts:10 +medusa/dist/models/product-option.d.ts:10 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -62,17 +64,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/product-option.d.ts:9 +medusa/dist/models/product-option.d.ts:9 ___ @@ -82,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-option.d.ts:8 +medusa/dist/models/product-option.d.ts:8 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-option.d.ts:7 +medusa/dist/models/product-option.d.ts:7 ___ @@ -102,13 +104,13 @@ ___ #### Defined in -packages/medusa/dist/models/product-option.d.ts:5 +medusa/dist/models/product-option.d.ts:5 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -116,7 +118,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -126,4 +128,4 @@ ___ #### Defined in -packages/medusa/dist/models/product-option.d.ts:6 +medusa/dist/models/product-option.d.ts:6 diff --git a/docs/content/references/js-client/classes/internal.ProductOptionReq.md b/docs/content/references/js-client/classes/internal.ProductOptionReq.md deleted file mode 100644 index 61b8715749..0000000000 --- a/docs/content/references/js-client/classes/internal.ProductOptionReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductOptionReq - -[internal](../modules/internal.md).ProductOptionReq - -## Properties - -### title - -• **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:204 diff --git a/docs/content/references/js-client/classes/internal.ProductOptionValue.md b/docs/content/references/js-client/classes/internal.ProductOptionValue.md index acd474ae15..c74ab39f48 100644 --- a/docs/content/references/js-client/classes/internal.ProductOptionValue.md +++ b/docs/content/references/js-client/classes/internal.ProductOptionValue.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ProductOptionValue +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/product-option-value.d.ts:11 +medusa/dist/models/product-option-value.d.ts:11 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -62,17 +64,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/product-option-value.d.ts:10 +medusa/dist/models/product-option-value.d.ts:10 ___ @@ -82,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-option-value.d.ts:7 +medusa/dist/models/product-option-value.d.ts:7 ___ @@ -92,13 +94,13 @@ ___ #### Defined in -packages/medusa/dist/models/product-option-value.d.ts:6 +medusa/dist/models/product-option-value.d.ts:6 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -106,7 +108,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -116,7 +118,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-option-value.d.ts:5 +medusa/dist/models/product-option-value.d.ts:5 ___ @@ -126,7 +128,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-option-value.d.ts:9 +medusa/dist/models/product-option-value.d.ts:9 ___ @@ -136,4 +138,4 @@ ___ #### Defined in -packages/medusa/dist/models/product-option-value.d.ts:8 +medusa/dist/models/product-option-value.d.ts:8 diff --git a/docs/content/references/js-client/classes/internal.ProductTag.md b/docs/content/references/js-client/classes/internal.ProductTag.md index 2dacc3e2fe..0f9b3cdb03 100644 --- a/docs/content/references/js-client/classes/internal.ProductTag.md +++ b/docs/content/references/js-client/classes/internal.ProductTag.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ProductTag +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/product-tag.d.ts:5 +medusa/dist/models/product-tag.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -62,23 +64,23 @@ ___ #### 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/product-tag.d.ts:4 +medusa/dist/models/product-tag.d.ts:4 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -86,7 +88,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -96,4 +98,4 @@ ___ #### Defined in -packages/medusa/dist/models/product-tag.d.ts:3 +medusa/dist/models/product-tag.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.ProductTagReq.md b/docs/content/references/js-client/classes/internal.ProductTagReq.md deleted file mode 100644 index 22d10c2a5c..0000000000 --- a/docs/content/references/js-client/classes/internal.ProductTagReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductTagReq - -[internal](../modules/internal.md).ProductTagReq - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:197 - -___ - -### value - -• **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:198 diff --git a/docs/content/references/js-client/classes/internal.ProductType.md b/docs/content/references/js-client/classes/internal.ProductType.md index 9c71b0a730..5a0898e1f4 100644 --- a/docs/content/references/js-client/classes/internal.ProductType.md +++ b/docs/content/references/js-client/classes/internal.ProductType.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ProductType +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/product-type.d.ts:5 +medusa/dist/models/product-type.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -62,23 +64,23 @@ ___ #### 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/product-type.d.ts:4 +medusa/dist/models/product-type.d.ts:4 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -86,7 +88,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -96,4 +98,4 @@ ___ #### Defined in -packages/medusa/dist/models/product-type.d.ts:3 +medusa/dist/models/product-type.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.ProductTypeReq.md b/docs/content/references/js-client/classes/internal.ProductTypeReq.md deleted file mode 100644 index d0b986722c..0000000000 --- a/docs/content/references/js-client/classes/internal.ProductTypeReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductTypeReq - -[internal](../modules/internal.md).ProductTypeReq - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:193 - -___ - -### value - -• **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:194 diff --git a/docs/content/references/js-client/classes/internal.ProductVariant.md b/docs/content/references/js-client/classes/internal.ProductVariant.md index 4172fcd60b..6a4e03e6c8 100644 --- a/docs/content/references/js-client/classes/internal.ProductVariant.md +++ b/docs/content/references/js-client/classes/internal.ProductVariant.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ProductVariant +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/product-variant.d.ts:16 +medusa/dist/models/product-variant.d.ts:16 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:11 +medusa/dist/models/product-variant.d.ts:11 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:28 +medusa/dist/models/product-variant.d.ts:28 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,13 +56,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 +70,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:12 +medusa/dist/models/product-variant.d.ts:12 ___ @@ -88,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:24 +medusa/dist/models/product-variant.d.ts:24 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:18 +medusa/dist/models/product-variant.d.ts:18 ___ @@ -112,7 +114,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -122,7 +124,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:15 +medusa/dist/models/product-variant.d.ts:15 ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:23 +medusa/dist/models/product-variant.d.ts:23 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:17 +medusa/dist/models/product-variant.d.ts:17 ___ @@ -152,17 +154,17 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:21 +medusa/dist/models/product-variant.d.ts:21 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/product-variant.d.ts:27 +medusa/dist/models/product-variant.d.ts:27 ___ @@ -172,7 +174,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:20 +medusa/dist/models/product-variant.d.ts:20 ___ @@ -182,7 +184,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:26 +medusa/dist/models/product-variant.d.ts:26 ___ @@ -192,7 +194,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:19 +medusa/dist/models/product-variant.d.ts:19 ___ @@ -202,7 +204,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:9 +medusa/dist/models/product-variant.d.ts:9 ___ @@ -212,7 +214,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:8 +medusa/dist/models/product-variant.d.ts:8 ___ @@ -222,7 +224,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:7 +medusa/dist/models/product-variant.d.ts:7 ___ @@ -232,7 +234,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:10 +medusa/dist/models/product-variant.d.ts:10 ___ @@ -242,7 +244,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:6 +medusa/dist/models/product-variant.d.ts:6 ___ @@ -252,13 +254,13 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:13 +medusa/dist/models/product-variant.d.ts:13 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -266,7 +268,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -276,7 +278,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:14 +medusa/dist/models/product-variant.d.ts:14 ___ @@ -286,7 +288,7 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:22 +medusa/dist/models/product-variant.d.ts:22 ___ @@ -296,4 +298,4 @@ ___ #### Defined in -packages/medusa/dist/models/product-variant.d.ts:25 +medusa/dist/models/product-variant.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.ProductVariantOptionReq.md b/docs/content/references/js-client/classes/internal.ProductVariantOptionReq.md deleted file mode 100644 index ab336554f7..0000000000 --- a/docs/content/references/js-client/classes/internal.ProductVariantOptionReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductVariantOptionReq - -[internal](../modules/internal.md).ProductVariantOptionReq - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:115 - -___ - -### value - -• **value**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:114 diff --git a/docs/content/references/js-client/classes/internal.ProductVariantReq.md b/docs/content/references/js-client/classes/internal.ProductVariantReq.md deleted file mode 100644 index 13c68c7b86..0000000000 --- a/docs/content/references/js-client/classes/internal.ProductVariantReq.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductVariantReq - -[internal](../modules/internal.md).ProductVariantReq - -## Properties - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:214 - -___ - -### barcode - -• `Optional` **barcode**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:211 - -___ - -### ean - -• `Optional` **ean**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:209 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:218 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:212 - -___ - -### inventory\_quantity - -• **inventory\_quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:213 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:217 - -___ - -### manage\_inventory - -• `Optional` **manage\_inventory**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:215 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:222 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:223 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:221 - -___ - -### options - -• `Optional` **options**: `ProductVariantOptionReq`[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:225 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:220 - -___ - -### prices - -• **prices**: [`ProductVariantPricesCreateReq`](internal.ProductVariantPricesCreateReq.md)[] - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:224 - -___ - -### sku - -• `Optional` **sku**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:208 - -___ - -### title - -• **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:207 - -___ - -### upc - -• `Optional` **upc**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:210 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:216 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/products/create-product.d.ts:219 diff --git a/docs/content/references/js-client/classes/internal.Refund.md b/docs/content/references/js-client/classes/internal.Refund.md index 682fc16ec7..c68a57e490 100644 --- a/docs/content/references/js-client/classes/internal.Refund.md +++ b/docs/content/references/js-client/classes/internal.Refund.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Refund +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/refund.d.ts:13 +medusa/dist/models/refund.d.ts:13 ___ @@ -30,13 +32,13 @@ ___ #### Defined in -packages/medusa/dist/models/refund.d.ts:18 +medusa/dist/models/refund.d.ts:18 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -44,7 +46,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -58,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -68,17 +70,17 @@ ___ #### Defined in -packages/medusa/dist/models/refund.d.ts:17 +medusa/dist/models/refund.d.ts:17 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/refund.d.ts:16 +medusa/dist/models/refund.d.ts:16 ___ @@ -88,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/models/refund.d.ts:14 +medusa/dist/models/refund.d.ts:14 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/models/refund.d.ts:12 +medusa/dist/models/refund.d.ts:12 ___ @@ -108,7 +110,7 @@ ___ #### Defined in -packages/medusa/dist/models/refund.d.ts:11 +medusa/dist/models/refund.d.ts:11 ___ @@ -118,13 +120,13 @@ ___ #### Defined in -packages/medusa/dist/models/refund.d.ts:15 +medusa/dist/models/refund.d.ts:15 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -132,4 +134,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.Region.md b/docs/content/references/js-client/classes/internal.Region.md index 46b534b951..a8e0693ca8 100644 --- a/docs/content/references/js-client/classes/internal.Region.md +++ b/docs/content/references/js-client/classes/internal.Region.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Region +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/region.d.ts:16 +medusa/dist/models/region.d.ts:16 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:23 +medusa/dist/models/region.d.ts:23 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:17 +medusa/dist/models/region.d.ts:17 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,7 +56,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -64,7 +66,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:11 +medusa/dist/models/region.d.ts:11 ___ @@ -74,13 +76,13 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:10 +medusa/dist/models/region.d.ts:10 ___ ### deleted\_at -• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **deleted\_at**: ``null`` \| `Date` #### Inherited from @@ -88,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:21 +medusa/dist/models/region.d.ts:21 ___ @@ -108,7 +110,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:15 +medusa/dist/models/region.d.ts:15 ___ @@ -122,17 +124,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/region.d.ts:22 +medusa/dist/models/region.d.ts:22 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:9 +medusa/dist/models/region.d.ts:9 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:20 +medusa/dist/models/region.d.ts:20 ___ @@ -162,7 +164,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:14 +medusa/dist/models/region.d.ts:14 ___ @@ -172,7 +174,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:19 +medusa/dist/models/region.d.ts:19 ___ @@ -182,7 +184,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:18 +medusa/dist/models/region.d.ts:18 ___ @@ -192,7 +194,7 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:12 +medusa/dist/models/region.d.ts:12 ___ @@ -202,13 +204,13 @@ ___ #### Defined in -packages/medusa/dist/models/region.d.ts:13 +medusa/dist/models/region.d.ts:13 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -216,4 +218,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.Return.md b/docs/content/references/js-client/classes/internal.Return.md index 071eed7c26..e23c97c5b3 100644 --- a/docs/content/references/js-client/classes/internal.Return.md +++ b/docs/content/references/js-client/classes/internal.Return.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Return +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/return.d.ts:29 +medusa/dist/models/return.d.ts:29 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:19 +medusa/dist/models/return.d.ts:19 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:18 +medusa/dist/models/return.d.ts:18 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,7 +56,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -68,7 +70,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:28 +medusa/dist/models/return.d.ts:28 ___ @@ -88,17 +90,17 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:15 +medusa/dist/models/return.d.ts:15 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/return.d.ts:27 +medusa/dist/models/return.d.ts:27 ___ @@ -108,7 +110,7 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:26 +medusa/dist/models/return.d.ts:26 ___ @@ -118,7 +120,7 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:21 +medusa/dist/models/return.d.ts:21 ___ @@ -128,17 +130,17 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:20 +medusa/dist/models/return.d.ts:20 ___ ### received\_at -• **received\_at**: [`Date`](../modules/internal.md#date) +• **received\_at**: `Date` #### Defined in -packages/medusa/dist/models/return.d.ts:25 +medusa/dist/models/return.d.ts:25 ___ @@ -148,17 +150,17 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:24 +medusa/dist/models/return.d.ts:24 ___ ### shipping\_data -• **shipping\_data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **shipping\_data**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/return.d.ts:23 +medusa/dist/models/return.d.ts:23 ___ @@ -168,7 +170,7 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:22 +medusa/dist/models/return.d.ts:22 ___ @@ -178,7 +180,7 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:14 +medusa/dist/models/return.d.ts:14 ___ @@ -188,7 +190,7 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:17 +medusa/dist/models/return.d.ts:17 ___ @@ -198,13 +200,13 @@ ___ #### Defined in -packages/medusa/dist/models/return.d.ts:16 +medusa/dist/models/return.d.ts:16 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -212,4 +214,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ReturnItem.md b/docs/content/references/js-client/classes/internal.ReturnItem.md index 8588d39d8c..0e1c260903 100644 --- a/docs/content/references/js-client/classes/internal.ReturnItem.md +++ b/docs/content/references/js-client/classes/internal.ReturnItem.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/return-item.d.ts:10 +medusa/dist/models/return-item.d.ts:10 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:8 +medusa/dist/models/return-item.d.ts:8 ___ @@ -34,17 +34,17 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:6 +medusa/dist/models/return-item.d.ts:6 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/return-item.d.ts:16 +medusa/dist/models/return-item.d.ts:16 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:15 +medusa/dist/models/return-item.d.ts:15 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:9 +medusa/dist/models/return-item.d.ts:9 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:14 +medusa/dist/models/return-item.d.ts:14 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:13 +medusa/dist/models/return-item.d.ts:13 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:12 +medusa/dist/models/return-item.d.ts:12 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:11 +medusa/dist/models/return-item.d.ts:11 ___ @@ -114,7 +114,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:5 +medusa/dist/models/return-item.d.ts:5 ___ @@ -124,4 +124,4 @@ ___ #### Defined in -packages/medusa/dist/models/return-item.d.ts:7 +medusa/dist/models/return-item.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ReturnReason.md b/docs/content/references/js-client/classes/internal.ReturnReason.md index e0234428a0..6d0ccf92f0 100644 --- a/docs/content/references/js-client/classes/internal.ReturnReason.md +++ b/docs/content/references/js-client/classes/internal.ReturnReason.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ReturnReason +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/return-reason.d.ts:10 +medusa/dist/models/return-reason.d.ts:10 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -58,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/models/return-reason.d.ts:5 +medusa/dist/models/return-reason.d.ts:5 ___ @@ -72,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -82,37 +84,37 @@ ___ #### Defined in -packages/medusa/dist/models/return-reason.d.ts:4 +medusa/dist/models/return-reason.d.ts:4 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/return-reason.d.ts:9 +medusa/dist/models/return-reason.d.ts:9 ___ ### parent\_return\_reason -• **parent\_return\_reason**: [`ReturnReason`](internal.ReturnReason.md) +• **parent\_return\_reason**: ``null`` \| [`ReturnReason`](internal.ReturnReason.md) #### Defined in -packages/medusa/dist/models/return-reason.d.ts:7 +medusa/dist/models/return-reason.d.ts:7 ___ ### parent\_return\_reason\_id -• **parent\_return\_reason\_id**: `string` +• **parent\_return\_reason\_id**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/return-reason.d.ts:6 +medusa/dist/models/return-reason.d.ts:6 ___ @@ -122,13 +124,13 @@ ___ #### Defined in -packages/medusa/dist/models/return-reason.d.ts:8 +medusa/dist/models/return-reason.d.ts:8 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -136,7 +138,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -146,4 +148,4 @@ ___ #### Defined in -packages/medusa/dist/models/return-reason.d.ts:3 +medusa/dist/models/return-reason.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.ReturnShipping.md b/docs/content/references/js-client/classes/internal.ReturnShipping.md deleted file mode 100644 index ada78d7b6d..0000000000 --- a/docs/content/references/js-client/classes/internal.ReturnShipping.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ReturnShipping - -[internal](../modules/internal.md).ReturnShipping - -## Properties - -### option\_id - -• `Optional` **option\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:76 - -___ - -### price - -• `Optional` **price**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:77 diff --git a/docs/content/references/js-client/classes/internal.SalesChannel.md b/docs/content/references/js-client/classes/internal.SalesChannel.md new file mode 100644 index 0000000000..6ada8e5e38 --- /dev/null +++ b/docs/content/references/js-client/classes/internal.SalesChannel.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SalesChannel + +[internal](../modules/internal.md).SalesChannel + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) + + ↳ **`SalesChannel`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +medusa/dist/models/sales-channel.d.ts:6 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### description + +• **description**: ``null`` \| `string` + +#### Defined in + +medusa/dist/models/sales-channel.d.ts:4 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +medusa/dist/models/sales-channel.d.ts:5 + +___ + +### name + +• **name**: `string` + +#### Defined in + +medusa/dist/models/sales-channel.d.ts:3 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) + +#### Defined in + +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ShippingAddressPayload.md b/docs/content/references/js-client/classes/internal.ShippingAddressPayload.md deleted file mode 100644 index 251849179a..0000000000 --- a/docs/content/references/js-client/classes/internal.ShippingAddressPayload.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ShippingAddressPayload - -[internal](../modules/internal.md).ShippingAddressPayload - -## Properties - -### postal\_code - -• `Optional` **postal\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.ShippingMethod.md b/docs/content/references/js-client/classes/internal.ShippingMethod.md index a3a60380b4..41e1710233 100644 --- a/docs/content/references/js-client/classes/internal.ShippingMethod.md +++ b/docs/content/references/js-client/classes/internal.ShippingMethod.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:25 +medusa/dist/models/shipping-method.d.ts:25 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:16 +medusa/dist/models/shipping-method.d.ts:16 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:15 +medusa/dist/models/shipping-method.d.ts:15 ___ @@ -44,27 +44,27 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:14 +medusa/dist/models/shipping-method.d.ts:14 ___ ### claim\_order\_id -• **claim\_order\_id**: `string` +• **claim\_order\_id**: ``null`` \| `string` #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:13 +medusa/dist/models/shipping-method.d.ts:13 ___ ### data -• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **data**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:24 +medusa/dist/models/shipping-method.d.ts:24 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:9 +medusa/dist/models/shipping-method.d.ts:9 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:12 +medusa/dist/models/shipping-method.d.ts:12 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:11 +medusa/dist/models/shipping-method.d.ts:11 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:23 +medusa/dist/models/shipping-method.d.ts:23 ___ @@ -114,7 +114,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:19 +medusa/dist/models/shipping-method.d.ts:19 ___ @@ -124,7 +124,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:20 +medusa/dist/models/shipping-method.d.ts:20 ___ @@ -134,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:21 +medusa/dist/models/shipping-method.d.ts:21 ___ @@ -144,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:10 +medusa/dist/models/shipping-method.d.ts:10 ___ @@ -154,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:18 +medusa/dist/models/shipping-method.d.ts:18 ___ @@ -164,7 +164,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:17 +medusa/dist/models/shipping-method.d.ts:17 ___ @@ -174,4 +174,4 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method.d.ts:22 +medusa/dist/models/shipping-method.d.ts:22 diff --git a/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md b/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md index 5bfe653556..d1f050fab2 100644 --- a/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md +++ b/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ShippingMethodTaxLine +Base abstract entity for all entities + ## Hierarchy - [`TaxLine`](internal.TaxLine.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/shipping-method-tax-line.d.ts:6 +medusa/dist/models/shipping-method-tax-line.d.ts:6 ___ @@ -34,13 +36,13 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:5 +medusa/dist/models/tax-line.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -62,13 +64,13 @@ ___ #### 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`\> #### Inherited from @@ -76,7 +78,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:6 +medusa/dist/models/tax-line.d.ts:6 ___ @@ -90,7 +92,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:4 +medusa/dist/models/tax-line.d.ts:4 ___ @@ -104,7 +106,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:3 +medusa/dist/models/tax-line.d.ts:3 ___ @@ -114,7 +116,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method-tax-line.d.ts:5 +medusa/dist/models/shipping-method-tax-line.d.ts:5 ___ @@ -124,13 +126,13 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-method-tax-line.d.ts:4 +medusa/dist/models/shipping-method-tax-line.d.ts:4 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -138,4 +140,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ShippingOption.md b/docs/content/references/js-client/classes/internal.ShippingOption.md index cd44e0fc49..e0f23b6004 100644 --- a/docs/content/references/js-client/classes/internal.ShippingOption.md +++ b/docs/content/references/js-client/classes/internal.ShippingOption.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ShippingOption +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,17 +22,17 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:21 +medusa/dist/models/shipping-option.d.ts:21 ___ ### amount -• **amount**: `number` +• **amount**: ``null`` \| `number` #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:19 +medusa/dist/models/shipping-option.d.ts:19 ___ @@ -40,13 +42,13 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:25 +medusa/dist/models/shipping-option.d.ts:25 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -54,23 +56,23 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ ### data -• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **data**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:23 +medusa/dist/models/shipping-option.d.ts:23 ___ ### deleted\_at -• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date) +• **deleted\_at**: ``null`` \| `Date` #### Inherited from @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -102,17 +104,17 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:20 +medusa/dist/models/shipping-option.d.ts:20 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:24 +medusa/dist/models/shipping-option.d.ts:24 ___ @@ -122,7 +124,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:11 +medusa/dist/models/shipping-option.d.ts:11 ___ @@ -132,7 +134,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:18 +medusa/dist/models/shipping-option.d.ts:18 ___ @@ -142,7 +144,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:15 +medusa/dist/models/shipping-option.d.ts:15 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:14 +medusa/dist/models/shipping-option.d.ts:14 ___ @@ -162,7 +164,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:17 +medusa/dist/models/shipping-option.d.ts:17 ___ @@ -172,7 +174,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:16 +medusa/dist/models/shipping-option.d.ts:16 ___ @@ -182,7 +184,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:13 +medusa/dist/models/shipping-option.d.ts:13 ___ @@ -192,7 +194,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:12 +medusa/dist/models/shipping-option.d.ts:12 ___ @@ -202,13 +204,13 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:22 +medusa/dist/models/shipping-option.d.ts:22 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -216,4 +218,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md b/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md index 575ce8871b..9ca516cf76 100644 --- a/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md +++ b/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:11 +medusa/dist/models/shipping-option-requirement.d.ts:11 ___ @@ -24,17 +24,17 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:13 +medusa/dist/models/shipping-option-requirement.d.ts:13 ___ ### deleted\_at -• **deleted\_at**: [`Date`](../modules/internal.md#date) +• **deleted\_at**: `Date` #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:12 +medusa/dist/models/shipping-option-requirement.d.ts:12 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:7 +medusa/dist/models/shipping-option-requirement.d.ts:7 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:9 +medusa/dist/models/shipping-option-requirement.d.ts:9 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:8 +medusa/dist/models/shipping-option-requirement.d.ts:8 ___ @@ -74,4 +74,4 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:10 +medusa/dist/models/shipping-option-requirement.d.ts:10 diff --git a/docs/content/references/js-client/classes/internal.ShippingProfile.md b/docs/content/references/js-client/classes/internal.ShippingProfile.md index e75b180fdc..1593640484 100644 --- a/docs/content/references/js-client/classes/internal.ShippingProfile.md +++ b/docs/content/references/js-client/classes/internal.ShippingProfile.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ShippingProfile +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/shipping-profile.d.ts:15 +medusa/dist/models/shipping-profile.d.ts:15 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -62,17 +64,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/shipping-profile.d.ts:14 +medusa/dist/models/shipping-profile.d.ts:14 ___ @@ -82,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-profile.d.ts:10 +medusa/dist/models/shipping-profile.d.ts:10 ___ @@ -92,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-profile.d.ts:12 +medusa/dist/models/shipping-profile.d.ts:12 ___ @@ -102,7 +104,7 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-profile.d.ts:13 +medusa/dist/models/shipping-profile.d.ts:13 ___ @@ -112,13 +114,13 @@ ___ #### Defined in -packages/medusa/dist/models/shipping-profile.d.ts:11 +medusa/dist/models/shipping-profile.d.ts:11 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -126,4 +128,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md b/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md index a62437ea5b..9bc391391b 100644 --- a/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md +++ b/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).SoftDeletableEntity +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -30,6 +32,8 @@ displayed_sidebar: jsClientSidebar ↳↳ [`Swap`](internal.Swap.md) + ↳↳ [`SalesChannel`](internal.SalesChannel.md) + ↳↳ [`PriceList`](internal.PriceList.md) ↳↳ [`DiscountRule`](internal.DiscountRule.md) @@ -68,17 +72,19 @@ displayed_sidebar: jsClientSidebar ↳↳ [`ProductTag`](internal.ProductTag.md) - ↳↳ [`User`](internal.User.md) + ↳↳ [`User`](internal-1.User.md) - ↳↳ [`Invite`](internal.Invite.md) + ↳↳ [`BatchJob`](internal-2.BatchJob.md) - ↳↳ [`Note`](internal.Note.md) + ↳↳ [`Invite`](internal-9.Invite.md) + + ↳↳ [`Note`](internal-10.Note.md) ## Properties ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -86,17 +92,17 @@ displayed_sidebar: jsClientSidebar #### 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` #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -110,13 +116,13 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -124,4 +130,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.StoreGetCollectionsParams.md b/docs/content/references/js-client/classes/internal.StoreGetCollectionsParams.md deleted file mode 100644 index a36e12ac50..0000000000 --- a/docs/content/references/js-client/classes/internal.StoreGetCollectionsParams.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetCollectionsParams - -[internal](../modules/internal.md).StoreGetCollectionsParams - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:27 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:25 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:26 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.StoreGetCustomersCustomerOrdersParams.md b/docs/content/references/js-client/classes/internal.StoreGetCustomersCustomerOrdersParams.md deleted file mode 100644 index 31b538ee07..0000000000 --- a/docs/content/references/js-client/classes/internal.StoreGetCustomersCustomerOrdersParams.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetCustomersCustomerOrdersParams - -[internal](../modules/internal.md).StoreGetCustomersCustomerOrdersParams - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:41 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:40 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:38 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:39 diff --git a/docs/content/references/js-client/classes/internal.StoreGetOrdersParams.md b/docs/content/references/js-client/classes/internal.StoreGetOrdersParams.md deleted file mode 100644 index 3587786270..0000000000 --- a/docs/content/references/js-client/classes/internal.StoreGetOrdersParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetOrdersParams - -[internal](../modules/internal.md).StoreGetOrdersParams - -## Properties - -### display\_id - -• **display\_id**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:27 - -___ - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:28 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal.ShippingAddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:29 diff --git a/docs/content/references/js-client/classes/internal.StoreGetProductsPaginationParams.md b/docs/content/references/js-client/classes/internal.StoreGetProductsPaginationParams.md deleted file mode 100644 index 8a29e3ace4..0000000000 --- a/docs/content/references/js-client/classes/internal.StoreGetProductsPaginationParams.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetProductsPaginationParams - -[internal](../modules/internal.md).StoreGetProductsPaginationParams - -## Hierarchy - -- [`PriceSelectionParams`](internal.PriceSelectionParams.md) - - ↳ **`StoreGetProductsPaginationParams`** - - ↳↳ [`StoreGetProductsParams`](internal.StoreGetProductsParams.md) - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal.PriceSelectionParams.md).[cart_id](internal.PriceSelectionParams.md#cart_id) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:2 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[PriceSelectionParams](internal.PriceSelectionParams.md).[currency_code](internal.PriceSelectionParams.md#currency_code) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:4 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:50 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:49 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:52 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:51 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal.PriceSelectionParams.md).[region_id](internal.PriceSelectionParams.md#region_id) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.StoreGetProductsParams.md b/docs/content/references/js-client/classes/internal.StoreGetProductsParams.md deleted file mode 100644 index 9693f1e0b9..0000000000 --- a/docs/content/references/js-client/classes/internal.StoreGetProductsParams.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetProductsParams - -[internal](../modules/internal.md).StoreGetProductsParams - -## Hierarchy - -- [`StoreGetProductsPaginationParams`](internal.StoreGetProductsPaginationParams.md) - - ↳ **`StoreGetProductsParams`** - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[cart_id](internal.StoreGetProductsPaginationParams.md#cart_id) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:2 - -___ - -### collection\_id - -• `Optional` **collection\_id**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:57 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:64 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[currency_code](internal.StoreGetProductsPaginationParams.md#currency_code) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:4 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:60 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[expand](internal.StoreGetProductsPaginationParams.md#expand) - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:50 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[fields](internal.StoreGetProductsPaginationParams.md#fields) - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:49 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:61 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:55 - -___ - -### is\_giftcard - -• `Optional` **is\_giftcard**: `boolean` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:62 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[limit](internal.StoreGetProductsPaginationParams.md#limit) - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:52 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[offset](internal.StoreGetProductsPaginationParams.md#offset) - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:51 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:56 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal.StoreGetProductsPaginationParams.md).[region_id](internal.StoreGetProductsPaginationParams.md#region_id) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:3 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:58 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:59 - -___ - -### type - -• `Optional` **type**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:63 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/products/list-products.d.ts:65 diff --git a/docs/content/references/js-client/classes/internal.StoreGetShippingOptionsParams.md b/docs/content/references/js-client/classes/internal.StoreGetShippingOptionsParams.md deleted file mode 100644 index 4b11df922d..0000000000 --- a/docs/content/references/js-client/classes/internal.StoreGetShippingOptionsParams.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetShippingOptionsParams - -[internal](../modules/internal.md).StoreGetShippingOptionsParams - -## Properties - -### is\_return - -• `Optional` **is\_return**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:29 - -___ - -### product\_ids - -• `Optional` **product\_ids**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:27 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:28 diff --git a/docs/content/references/js-client/classes/internal.StoreGetVariantsParams.md b/docs/content/references/js-client/classes/internal.StoreGetVariantsParams.md deleted file mode 100644 index 5b82cdc339..0000000000 --- a/docs/content/references/js-client/classes/internal.StoreGetVariantsParams.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StoreGetVariantsParams - -[internal](../modules/internal.md).StoreGetVariantsParams - -## Hierarchy - -- [`PriceSelectionParams`](internal.PriceSelectionParams.md) - - ↳ **`StoreGetVariantsParams`** - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal.PriceSelectionParams.md).[cart_id](internal.PriceSelectionParams.md#cart_id) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:2 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[PriceSelectionParams](internal.PriceSelectionParams.md).[currency_code](internal.PriceSelectionParams.md#currency_code) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:4 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:32 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:34 - -___ - -### ids - -• `Optional` **ids**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:33 - -___ - -### inventory\_quantity - -• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal.NumericalComparisonOperator.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:36 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:30 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:31 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal.PriceSelectionParams.md).[region_id](internal.PriceSelectionParams.md#region_id) - -#### Defined in - -packages/medusa/dist/types/price-selection.d.ts:3 - -___ - -### title - -• `Optional` **title**: `string` \| `string`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:35 diff --git a/docs/content/references/js-client/classes/internal.StorePostAuthReq.md b/docs/content/references/js-client/classes/internal.StorePostAuthReq.md deleted file mode 100644 index b8df1236c5..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostAuthReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostAuthReq - -[internal](../modules/internal.md).StorePostAuthReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/auth/create-session.d.ts:24 - -___ - -### password - -• **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/auth/create-session.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartReq.md b/docs/content/references/js-client/classes/internal.StorePostCartReq.md deleted file mode 100644 index aad768f916..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCartReq.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCartReq - -[internal](../modules/internal.md).StorePostCartReq - -## Properties - -### context - -• `Optional` **context**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:56 - -___ - -### country\_code - -• `Optional` **country\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:54 - -___ - -### items - -• `Optional` **items**: `Item`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:55 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:53 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsItemReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsItemReq.md deleted file mode 100644 index 3f3cb5c944..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsItemReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCartsCartLineItemsItemReq - -[internal](../modules/internal.md).StorePostCartsCartLineItemsItemReq - -## Properties - -### quantity - -• **quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-line-item.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsReq.md deleted file mode 100644 index 071b556989..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCartsCartLineItemsReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCartsCartLineItemsReq - -[internal](../modules/internal.md).StorePostCartsCartLineItemsReq - -## Properties - -### metadata - -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/create-line-item.d.ts:29 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/create-line-item.d.ts:28 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/create-line-item.d.ts:27 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionReq.md deleted file mode 100644 index 18edea0240..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCartsCartPaymentSessionReq - -[internal](../modules/internal.md).StorePostCartsCartPaymentSessionReq - -## Properties - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/set-payment-session.d.ts:24 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionUpdateReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionUpdateReq.md deleted file mode 100644 index 9785ca8da9..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCartsCartPaymentSessionUpdateReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCartsCartPaymentSessionUpdateReq - -[internal](../modules/internal.md).StorePostCartsCartPaymentSessionUpdateReq - -## Properties - -### data - -• **data**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-payment-session.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartReq.md deleted file mode 100644 index 35f7d4e19f..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCartsCartReq.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCartsCartReq - -[internal](../modules/internal.md).StorePostCartsCartReq - -## Properties - -### billing\_address - -• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:81 - -___ - -### context - -• `Optional` **context**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:86 - -___ - -### country\_code - -• `Optional` **country\_code**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:79 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:85 - -___ - -### discounts - -• `Optional` **discounts**: `Discount`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:84 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:80 - -___ - -### gift\_cards - -• `Optional` **gift\_cards**: `GiftCard`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:83 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:78 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:82 diff --git a/docs/content/references/js-client/classes/internal.StorePostCartsCartShippingMethodReq.md b/docs/content/references/js-client/classes/internal.StorePostCartsCartShippingMethodReq.md deleted file mode 100644 index 08f676cc2e..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCartsCartShippingMethodReq.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCartsCartShippingMethodReq - -[internal](../modules/internal.md).StorePostCartsCartShippingMethodReq - -## Properties - -### data - -• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `any`\> - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:26 - -___ - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:25 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md index 50cda4f84d..28589fbe04 100644 --- a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md @@ -24,7 +24,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/types/common.d.ts:68 +medusa/dist/types/common.d.ts:95 ___ @@ -38,7 +38,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:69 +medusa/dist/types/common.d.ts:96 ___ @@ -52,7 +52,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:70 +medusa/dist/types/common.d.ts:97 ___ @@ -66,7 +66,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:67 +medusa/dist/types/common.d.ts:94 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:71 +medusa/dist/types/common.d.ts:98 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:63 +medusa/dist/types/common.d.ts:90 ___ @@ -108,13 +108,13 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:64 +medusa/dist/types/common.d.ts:91 ___ ### metadata -• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• `Optional` **metadata**: `Record`<`string`, `unknown`\> #### Inherited from @@ -122,7 +122,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:66 +medusa/dist/types/common.d.ts:93 ___ @@ -136,7 +136,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:65 +medusa/dist/types/common.d.ts:92 ___ @@ -150,7 +150,7 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:73 +medusa/dist/types/common.d.ts:100 ___ @@ -164,4 +164,4 @@ ___ #### Defined in -packages/medusa/dist/types/common.d.ts:72 +medusa/dist/types/common.d.ts:99 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md index 5118e0ced8..29ad5a5d54 100644 --- a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md +++ b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md @@ -14,4 +14,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/api/routes/store/customers/create-address.d.ts:34 +medusa/dist/api/routes/store/customers/create-address.d.ts:34 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerPasswordTokenReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerPasswordTokenReq.md deleted file mode 100644 index b8ff317a6b..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerPasswordTokenReq.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCustomersCustomerPasswordTokenReq - -[internal](../modules/internal.md).StorePostCustomersCustomerPasswordTokenReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/reset-password-token.d.ts:17 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerReq.md deleted file mode 100644 index 4914cc2c10..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerReq.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCustomersCustomerReq - -[internal](../modules/internal.md).StorePostCustomersCustomerReq - -## Properties - -### billing\_address - -• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:50 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:55 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:51 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:52 - -___ - -### metadata - -• `Optional` **metadata**: `object` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:56 - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:53 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:54 diff --git a/docs/content/references/js-client/classes/internal.StorePostCustomersReq.md b/docs/content/references/js-client/classes/internal.StorePostCustomersReq.md deleted file mode 100644 index 74c71715f6..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostCustomersReq.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostCustomersReq - -[internal](../modules/internal.md).StorePostCustomersReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:29 - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:27 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:28 - -___ - -### password - -• **password**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:30 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:31 diff --git a/docs/content/references/js-client/classes/internal.StorePostReturnsReq.md b/docs/content/references/js-client/classes/internal.StorePostReturnsReq.md deleted file mode 100644 index 76a9720865..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostReturnsReq.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostReturnsReq - -[internal](../modules/internal.md).StorePostReturnsReq - -## Properties - -### items - -• **items**: `Item`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/returns/create-return.d.ts:65 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/returns/create-return.d.ts:64 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: `ReturnShipping` - -#### Defined in - -packages/medusa/dist/api/routes/store/returns/create-return.d.ts:66 diff --git a/docs/content/references/js-client/classes/internal.StorePostSearchReq.md b/docs/content/references/js-client/classes/internal.StorePostSearchReq.md deleted file mode 100644 index 10393fae3a..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostSearchReq.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostSearchReq - -[internal](../modules/internal.md).StorePostSearchReq - -## Properties - -### filter - -• `Optional` **filter**: `unknown` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/search.d.ts:7 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/search.d.ts:6 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/search.d.ts:5 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/products/search.d.ts:4 diff --git a/docs/content/references/js-client/classes/internal.StorePostSwapsReq.md b/docs/content/references/js-client/classes/internal.StorePostSwapsReq.md deleted file mode 100644 index 9b98ae0243..0000000000 --- a/docs/content/references/js-client/classes/internal.StorePostSwapsReq.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: StorePostSwapsReq - -[internal](../modules/internal.md).StorePostSwapsReq - -## Properties - -### additional\_items - -• **additional\_items**: `AdditionalItem`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:86 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:84 - -___ - -### return\_items - -• **return\_items**: `Item`[] - -#### Defined in - -packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:85 - -___ - -### return\_shipping\_option - -• `Optional` **return\_shipping\_option**: `string` - -#### Defined in - -packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:87 diff --git a/docs/content/references/js-client/classes/internal.Swap.md b/docs/content/references/js-client/classes/internal.Swap.md index 318733f6d3..f285191e33 100644 --- a/docs/content/references/js-client/classes/internal.Swap.md +++ b/docs/content/references/js-client/classes/internal.Swap.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).Swap +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/swap.d.ts:33 +medusa/dist/models/swap.d.ts:33 ___ @@ -30,7 +32,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:46 +medusa/dist/models/swap.d.ts:46 ___ @@ -40,17 +42,17 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:49 +medusa/dist/models/swap.d.ts:49 ___ ### canceled\_at -• **canceled\_at**: [`Date`](../modules/internal.md#date) +• **canceled\_at**: `Date` #### Defined in -packages/medusa/dist/models/swap.d.ts:44 +medusa/dist/models/swap.d.ts:44 ___ @@ -60,7 +62,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:42 +medusa/dist/models/swap.d.ts:42 ___ @@ -70,23 +72,23 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:41 +medusa/dist/models/swap.d.ts:41 ___ ### confirmed\_at -• **confirmed\_at**: [`Date`](../modules/internal.md#date) +• **confirmed\_at**: `Date` #### Defined in -packages/medusa/dist/models/swap.d.ts:43 +medusa/dist/models/swap.d.ts:43 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -94,13 +96,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 @@ -108,7 +110,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -118,7 +120,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:37 +medusa/dist/models/swap.d.ts:37 ___ @@ -128,7 +130,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:29 +medusa/dist/models/swap.d.ts:29 ___ @@ -138,7 +140,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:35 +medusa/dist/models/swap.d.ts:35 ___ @@ -152,7 +154,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -162,17 +164,17 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:47 +medusa/dist/models/swap.d.ts:47 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/swap.d.ts:48 +medusa/dist/models/swap.d.ts:48 ___ @@ -182,7 +184,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:45 +medusa/dist/models/swap.d.ts:45 ___ @@ -192,7 +194,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:32 +medusa/dist/models/swap.d.ts:32 ___ @@ -202,7 +204,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:31 +medusa/dist/models/swap.d.ts:31 ___ @@ -212,7 +214,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:36 +medusa/dist/models/swap.d.ts:36 ___ @@ -222,7 +224,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:30 +medusa/dist/models/swap.d.ts:30 ___ @@ -232,7 +234,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:34 +medusa/dist/models/swap.d.ts:34 ___ @@ -242,7 +244,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:39 +medusa/dist/models/swap.d.ts:39 ___ @@ -252,7 +254,7 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:38 +medusa/dist/models/swap.d.ts:38 ___ @@ -262,13 +264,13 @@ ___ #### Defined in -packages/medusa/dist/models/swap.d.ts:40 +medusa/dist/models/swap.d.ts:40 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -276,4 +278,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.TaxLine.md b/docs/content/references/js-client/classes/internal.TaxLine.md index 1e9143dc29..96781cfcaa 100644 --- a/docs/content/references/js-client/classes/internal.TaxLine.md +++ b/docs/content/references/js-client/classes/internal.TaxLine.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).TaxLine +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -24,13 +26,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/tax-line.d.ts:5 +medusa/dist/models/tax-line.d.ts:5 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -38,7 +40,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -52,17 +54,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/tax-line.d.ts:6 +medusa/dist/models/tax-line.d.ts:6 ___ @@ -72,7 +74,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:4 +medusa/dist/models/tax-line.d.ts:4 ___ @@ -82,13 +84,13 @@ ___ #### Defined in -packages/medusa/dist/models/tax-line.d.ts:3 +medusa/dist/models/tax-line.d.ts:3 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -96,4 +98,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.TaxProvider.md b/docs/content/references/js-client/classes/internal.TaxProvider.md index e7465bc2a6..b197e6c830 100644 --- a/docs/content/references/js-client/classes/internal.TaxProvider.md +++ b/docs/content/references/js-client/classes/internal.TaxProvider.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/tax-provider.d.ts:2 +medusa/dist/models/tax-provider.d.ts:2 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -packages/medusa/dist/models/tax-provider.d.ts:3 +medusa/dist/models/tax-provider.d.ts:3 diff --git a/docs/content/references/js-client/classes/internal.TaxRate.md b/docs/content/references/js-client/classes/internal.TaxRate.md index ccdc419491..d3c665b943 100644 --- a/docs/content/references/js-client/classes/internal.TaxRate.md +++ b/docs/content/references/js-client/classes/internal.TaxRate.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).TaxRate +Base abstract entity for all entities + ## Hierarchy - [`BaseEntity`](internal.BaseEntity.md) @@ -20,7 +22,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:19 +medusa/dist/models/tax-rate.d.ts:19 ___ @@ -30,13 +32,13 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:8 +medusa/dist/models/tax-rate.d.ts:8 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -44,7 +46,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:6 +medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -58,17 +60,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/tax-rate.d.ts:12 +medusa/dist/models/tax-rate.d.ts:12 ___ @@ -78,7 +80,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:9 +medusa/dist/models/tax-rate.d.ts:9 ___ @@ -88,7 +90,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:16 +medusa/dist/models/tax-rate.d.ts:16 ___ @@ -98,7 +100,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:17 +medusa/dist/models/tax-rate.d.ts:17 ___ @@ -108,7 +110,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:14 +medusa/dist/models/tax-rate.d.ts:14 ___ @@ -118,7 +120,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:13 +medusa/dist/models/tax-rate.d.ts:13 ___ @@ -128,7 +130,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:7 +medusa/dist/models/tax-rate.d.ts:7 ___ @@ -138,7 +140,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:11 +medusa/dist/models/tax-rate.d.ts:11 ___ @@ -148,7 +150,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:10 +medusa/dist/models/tax-rate.d.ts:10 ___ @@ -158,7 +160,7 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:18 +medusa/dist/models/tax-rate.d.ts:18 ___ @@ -168,13 +170,13 @@ ___ #### Defined in -packages/medusa/dist/models/tax-rate.d.ts:15 +medusa/dist/models/tax-rate.d.ts:15 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -182,4 +184,4 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/docs/content/references/js-client/classes/internal.TrackingLink.md b/docs/content/references/js-client/classes/internal.TrackingLink.md index f49d299e05..1b4fc2e00c 100644 --- a/docs/content/references/js-client/classes/internal.TrackingLink.md +++ b/docs/content/references/js-client/classes/internal.TrackingLink.md @@ -6,6 +6,8 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).TrackingLink +Base abstract entity for all entities + ## Hierarchy - [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) @@ -20,13 +22,13 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa/dist/models/tracking-link.d.ts:10 +medusa/dist/models/tracking-link.d.ts:10 ___ ### created\_at -• **created\_at**: [`Date`](../modules/internal.md#date) +• **created\_at**: `Date` #### Inherited from @@ -34,13 +36,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 @@ -48,7 +50,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -58,7 +60,7 @@ ___ #### Defined in -packages/medusa/dist/models/tracking-link.d.ts:7 +medusa/dist/models/tracking-link.d.ts:7 ___ @@ -68,7 +70,7 @@ ___ #### Defined in -packages/medusa/dist/models/tracking-link.d.ts:6 +medusa/dist/models/tracking-link.d.ts:6 ___ @@ -82,7 +84,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:5 +medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -92,17 +94,17 @@ ___ #### Defined in -packages/medusa/dist/models/tracking-link.d.ts:8 +medusa/dist/models/tracking-link.d.ts:8 ___ ### metadata -• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> +• **metadata**: `Record`<`string`, `unknown`\> #### Defined in -packages/medusa/dist/models/tracking-link.d.ts:9 +medusa/dist/models/tracking-link.d.ts:9 ___ @@ -112,13 +114,13 @@ ___ #### Defined in -packages/medusa/dist/models/tracking-link.d.ts:5 +medusa/dist/models/tracking-link.d.ts:5 ___ ### updated\_at -• **updated\_at**: [`Date`](../modules/internal.md#date) +• **updated\_at**: `Date` #### Inherited from @@ -126,7 +128,7 @@ ___ #### Defined in -packages/medusa/dist/interfaces/models/base-entity.d.ts:7 +medusa/dist/interfaces/models/base-entity.d.ts:7 ___ @@ -136,4 +138,4 @@ ___ #### Defined in -packages/medusa/dist/models/tracking-link.d.ts:4 +medusa/dist/models/tracking-link.d.ts:4 diff --git a/docs/content/references/js-client/enums/internal-1.UserRoles.md b/docs/content/references/js-client/enums/internal-1.UserRoles.md new file mode 100644 index 0000000000..ba306c053e --- /dev/null +++ b/docs/content/references/js-client/enums/internal-1.UserRoles.md @@ -0,0 +1,33 @@ +# Enumeration: UserRoles + +[internal](../modules/internal-1.md).UserRoles + +## Enumeration Members + +### ADMIN + +• **ADMIN** = ``"admin"`` + +#### Defined in + +medusa/dist/models/user.d.ts:3 + +___ + +### DEVELOPER + +• **DEVELOPER** = ``"developer"`` + +#### Defined in + +medusa/dist/models/user.d.ts:5 + +___ + +### MEMBER + +• **MEMBER** = ``"member"`` + +#### Defined in + +medusa/dist/models/user.d.ts:4 diff --git a/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md b/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md new file mode 100644 index 0000000000..22793e77f2 --- /dev/null +++ b/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md @@ -0,0 +1,73 @@ +# Enumeration: BatchJobStatus + +[internal](../modules/internal-2.md).BatchJobStatus + +## Enumeration Members + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +medusa/dist/types/batch-job.d.ts:9 + +___ + +### COMPLETED + +• **COMPLETED** = ``"completed"`` + +#### Defined in + +medusa/dist/types/batch-job.d.ts:8 + +___ + +### CONFIRMED + +• **CONFIRMED** = ``"confirmed"`` + +#### Defined in + +medusa/dist/types/batch-job.d.ts:6 + +___ + +### CREATED + +• **CREATED** = ``"created"`` + +#### Defined in + +medusa/dist/types/batch-job.d.ts:4 + +___ + +### FAILED + +• **FAILED** = ``"failed"`` + +#### Defined in + +medusa/dist/types/batch-job.d.ts:10 + +___ + +### PRE\_PROCESSED + +• **PRE\_PROCESSED** = ``"pre_processed"`` + +#### Defined in + +medusa/dist/types/batch-job.d.ts:5 + +___ + +### PROCESSING + +• **PROCESSING** = ``"processing"`` + +#### Defined in + +medusa/dist/types/batch-job.d.ts:7 diff --git a/docs/content/references/js-client/enums/internal.AllocationType.md b/docs/content/references/js-client/enums/internal.AllocationType.md index 3503425431..36a0a12f17 100644 --- a/docs/content/references/js-client/enums/internal.AllocationType.md +++ b/docs/content/references/js-client/enums/internal.AllocationType.md @@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).AllocationType -## Enumeration members +## Enumeration Members ### ITEM -• **ITEM** = `"item"` +• **ITEM** = ``"item"`` #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:10 +medusa/dist/models/discount-rule.d.ts:10 ___ ### TOTAL -• **TOTAL** = `"total"` +• **TOTAL** = ``"total"`` #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:9 +medusa/dist/models/discount-rule.d.ts:9 diff --git a/docs/content/references/js-client/enums/internal.CartType.md b/docs/content/references/js-client/enums/internal.CartType.md index a9a5c6cdf6..97ac895300 100644 --- a/docs/content/references/js-client/enums/internal.CartType.md +++ b/docs/content/references/js-client/enums/internal.CartType.md @@ -6,52 +6,52 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).CartType -## Enumeration members +## Enumeration Members ### CLAIM -• **CLAIM** = `"claim"` +• **CLAIM** = ``"claim"`` #### Defined in -packages/medusa/dist/models/cart.d.ts:99 +medusa/dist/models/cart.d.ts:100 ___ ### DEFAULT -• **DEFAULT** = `"default"` +• **DEFAULT** = ``"default"`` #### Defined in -packages/medusa/dist/models/cart.d.ts:95 +medusa/dist/models/cart.d.ts:96 ___ ### DRAFT\_ORDER -• **DRAFT\_ORDER** = `"draft_order"` +• **DRAFT\_ORDER** = ``"draft_order"`` #### Defined in -packages/medusa/dist/models/cart.d.ts:97 +medusa/dist/models/cart.d.ts:98 ___ ### PAYMENT\_LINK -• **PAYMENT\_LINK** = `"payment_link"` +• **PAYMENT\_LINK** = ``"payment_link"`` #### Defined in -packages/medusa/dist/models/cart.d.ts:98 +medusa/dist/models/cart.d.ts:99 ___ ### SWAP -• **SWAP** = `"swap"` +• **SWAP** = ``"swap"`` #### Defined in -packages/medusa/dist/models/cart.d.ts:96 +medusa/dist/models/cart.d.ts:97 diff --git a/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md b/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md index a6c87962f9..520a55f6ba 100644 --- a/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md +++ b/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md @@ -6,92 +6,92 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ClaimFulfillmentStatus -## Enumeration members +## Enumeration Members ### CANCELED -• **CANCELED** = `"canceled"` +• **CANCELED** = ``"canceled"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:26 +medusa/dist/models/claim-order.d.ts:26 ___ ### FULFILLED -• **FULFILLED** = `"fulfilled"` +• **FULFILLED** = ``"fulfilled"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:21 +medusa/dist/models/claim-order.d.ts:21 ___ ### NOT\_FULFILLED -• **NOT\_FULFILLED** = `"not_fulfilled"` +• **NOT\_FULFILLED** = ``"not_fulfilled"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:19 +medusa/dist/models/claim-order.d.ts:19 ___ ### PARTIALLY\_FULFILLED -• **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` +• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:20 +medusa/dist/models/claim-order.d.ts:20 ___ ### PARTIALLY\_RETURNED -• **PARTIALLY\_RETURNED** = `"partially_returned"` +• **PARTIALLY\_RETURNED** = ``"partially_returned"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:24 +medusa/dist/models/claim-order.d.ts:24 ___ ### PARTIALLY\_SHIPPED -• **PARTIALLY\_SHIPPED** = `"partially_shipped"` +• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:22 +medusa/dist/models/claim-order.d.ts:22 ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = `"requires_action"` +• **REQUIRES\_ACTION** = ``"requires_action"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:27 +medusa/dist/models/claim-order.d.ts:27 ___ ### RETURNED -• **RETURNED** = `"returned"` +• **RETURNED** = ``"returned"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:25 +medusa/dist/models/claim-order.d.ts:25 ___ ### SHIPPED -• **SHIPPED** = `"shipped"` +• **SHIPPED** = ``"shipped"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:23 +medusa/dist/models/claim-order.d.ts:23 diff --git a/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md b/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md index b090dac64e..26903125a4 100644 --- a/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md +++ b/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md @@ -6,32 +6,32 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ClaimPaymentStatus -## Enumeration members +## Enumeration Members ### NA -• **NA** = `"na"` +• **NA** = ``"na"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:14 +medusa/dist/models/claim-order.d.ts:14 ___ ### NOT\_REFUNDED -• **NOT\_REFUNDED** = `"not_refunded"` +• **NOT\_REFUNDED** = ``"not_refunded"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:15 +medusa/dist/models/claim-order.d.ts:15 ___ ### REFUNDED -• **REFUNDED** = `"refunded"` +• **REFUNDED** = ``"refunded"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:16 +medusa/dist/models/claim-order.d.ts:16 diff --git a/docs/content/references/js-client/enums/internal.ClaimReason.md b/docs/content/references/js-client/enums/internal.ClaimReason.md index 0fc127902e..f3eed9d64b 100644 --- a/docs/content/references/js-client/enums/internal.ClaimReason.md +++ b/docs/content/references/js-client/enums/internal.ClaimReason.md @@ -6,42 +6,42 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ClaimReason -## Enumeration members +## Enumeration Members ### MISSING\_ITEM -• **MISSING\_ITEM** = `"missing_item"` +• **MISSING\_ITEM** = ``"missing_item"`` #### Defined in -packages/medusa/dist/models/claim-item.d.ts:8 +medusa/dist/models/claim-item.d.ts:8 ___ ### OTHER -• **OTHER** = `"other"` +• **OTHER** = ``"other"`` #### Defined in -packages/medusa/dist/models/claim-item.d.ts:11 +medusa/dist/models/claim-item.d.ts:11 ___ ### PRODUCTION\_FAILURE -• **PRODUCTION\_FAILURE** = `"production_failure"` +• **PRODUCTION\_FAILURE** = ``"production_failure"`` #### Defined in -packages/medusa/dist/models/claim-item.d.ts:10 +medusa/dist/models/claim-item.d.ts:10 ___ ### WRONG\_ITEM -• **WRONG\_ITEM** = `"wrong_item"` +• **WRONG\_ITEM** = ``"wrong_item"`` #### Defined in -packages/medusa/dist/models/claim-item.d.ts:9 +medusa/dist/models/claim-item.d.ts:9 diff --git a/docs/content/references/js-client/enums/internal.ClaimType.md b/docs/content/references/js-client/enums/internal.ClaimType.md index a6cefd9bc6..7719828e6e 100644 --- a/docs/content/references/js-client/enums/internal.ClaimType.md +++ b/docs/content/references/js-client/enums/internal.ClaimType.md @@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ClaimType -## Enumeration members +## Enumeration Members ### REFUND -• **REFUND** = `"refund"` +• **REFUND** = ``"refund"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:10 +medusa/dist/models/claim-order.d.ts:10 ___ ### REPLACE -• **REPLACE** = `"replace"` +• **REPLACE** = ``"replace"`` #### Defined in -packages/medusa/dist/models/claim-order.d.ts:11 +medusa/dist/models/claim-order.d.ts:11 diff --git a/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md b/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md index 1c5202356b..6b4c61f7a6 100644 --- a/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md +++ b/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md @@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).DiscountConditionOperator -## Enumeration members +## Enumeration Members ### IN -• **IN** = `"in"` +• **IN** = ``"in"`` #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:16 +medusa/dist/models/discount-condition.d.ts:16 ___ ### NOT\_IN -• **NOT\_IN** = `"not_in"` +• **NOT\_IN** = ``"not_in"`` #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:17 +medusa/dist/models/discount-condition.d.ts:17 diff --git a/docs/content/references/js-client/enums/internal.DiscountConditionType.md b/docs/content/references/js-client/enums/internal.DiscountConditionType.md index 49cac5445c..8c84ec5b5b 100644 --- a/docs/content/references/js-client/enums/internal.DiscountConditionType.md +++ b/docs/content/references/js-client/enums/internal.DiscountConditionType.md @@ -6,52 +6,52 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).DiscountConditionType -## Enumeration members +## Enumeration Members ### CUSTOMER\_GROUPS -• **CUSTOMER\_GROUPS** = `"customer_groups"` +• **CUSTOMER\_GROUPS** = ``"customer_groups"`` #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:13 +medusa/dist/models/discount-condition.d.ts:13 ___ ### PRODUCTS -• **PRODUCTS** = `"products"` +• **PRODUCTS** = ``"products"`` #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:9 +medusa/dist/models/discount-condition.d.ts:9 ___ ### PRODUCT\_COLLECTIONS -• **PRODUCT\_COLLECTIONS** = `"product_collections"` +• **PRODUCT\_COLLECTIONS** = ``"product_collections"`` #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:11 +medusa/dist/models/discount-condition.d.ts:11 ___ ### PRODUCT\_TAGS -• **PRODUCT\_TAGS** = `"product_tags"` +• **PRODUCT\_TAGS** = ``"product_tags"`` #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:12 +medusa/dist/models/discount-condition.d.ts:12 ___ ### PRODUCT\_TYPES -• **PRODUCT\_TYPES** = `"product_types"` +• **PRODUCT\_TYPES** = ``"product_types"`` #### Defined in -packages/medusa/dist/models/discount-condition.d.ts:10 +medusa/dist/models/discount-condition.d.ts:10 diff --git a/docs/content/references/js-client/enums/internal.DiscountRuleType.md b/docs/content/references/js-client/enums/internal.DiscountRuleType.md index 95c5cace82..4775574377 100644 --- a/docs/content/references/js-client/enums/internal.DiscountRuleType.md +++ b/docs/content/references/js-client/enums/internal.DiscountRuleType.md @@ -6,32 +6,32 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).DiscountRuleType -## Enumeration members +## Enumeration Members ### FIXED -• **FIXED** = `"fixed"` +• **FIXED** = ``"fixed"`` #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:4 +medusa/dist/models/discount-rule.d.ts:4 ___ ### FREE\_SHIPPING -• **FREE\_SHIPPING** = `"free_shipping"` +• **FREE\_SHIPPING** = ``"free_shipping"`` #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:6 +medusa/dist/models/discount-rule.d.ts:6 ___ ### PERCENTAGE -• **PERCENTAGE** = `"percentage"` +• **PERCENTAGE** = ``"percentage"`` #### Defined in -packages/medusa/dist/models/discount-rule.d.ts:5 +medusa/dist/models/discount-rule.d.ts:5 diff --git a/docs/content/references/js-client/enums/internal.DraftOrderStatus.md b/docs/content/references/js-client/enums/internal.DraftOrderStatus.md index b0f25d4b05..74b022bc9c 100644 --- a/docs/content/references/js-client/enums/internal.DraftOrderStatus.md +++ b/docs/content/references/js-client/enums/internal.DraftOrderStatus.md @@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).DraftOrderStatus -## Enumeration members +## Enumeration Members ### COMPLETED -• **COMPLETED** = `"completed"` +• **COMPLETED** = ``"completed"`` #### Defined in -packages/medusa/dist/models/draft-order.d.ts:6 +medusa/dist/models/draft-order.d.ts:6 ___ ### OPEN -• **OPEN** = `"open"` +• **OPEN** = ``"open"`` #### Defined in -packages/medusa/dist/models/draft-order.d.ts:5 +medusa/dist/models/draft-order.d.ts:5 diff --git a/docs/content/references/js-client/enums/internal.FulfillmentStatus.md b/docs/content/references/js-client/enums/internal.FulfillmentStatus.md index cc82a79d0b..f1dc2ce7d3 100644 --- a/docs/content/references/js-client/enums/internal.FulfillmentStatus.md +++ b/docs/content/references/js-client/enums/internal.FulfillmentStatus.md @@ -6,92 +6,92 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).FulfillmentStatus -## Enumeration members +## Enumeration Members ### CANCELED -• **CANCELED** = `"canceled"` +• **CANCELED** = ``"canceled"`` #### Defined in -packages/medusa/dist/models/order.d.ts:34 +medusa/dist/models/order.d.ts:35 ___ ### FULFILLED -• **FULFILLED** = `"fulfilled"` +• **FULFILLED** = ``"fulfilled"`` #### Defined in -packages/medusa/dist/models/order.d.ts:29 +medusa/dist/models/order.d.ts:30 ___ ### NOT\_FULFILLED -• **NOT\_FULFILLED** = `"not_fulfilled"` +• **NOT\_FULFILLED** = ``"not_fulfilled"`` #### Defined in -packages/medusa/dist/models/order.d.ts:27 +medusa/dist/models/order.d.ts:28 ___ ### PARTIALLY\_FULFILLED -• **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` +• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` #### Defined in -packages/medusa/dist/models/order.d.ts:28 +medusa/dist/models/order.d.ts:29 ___ ### PARTIALLY\_RETURNED -• **PARTIALLY\_RETURNED** = `"partially_returned"` +• **PARTIALLY\_RETURNED** = ``"partially_returned"`` #### Defined in -packages/medusa/dist/models/order.d.ts:32 +medusa/dist/models/order.d.ts:33 ___ ### PARTIALLY\_SHIPPED -• **PARTIALLY\_SHIPPED** = `"partially_shipped"` +• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` #### Defined in -packages/medusa/dist/models/order.d.ts:30 +medusa/dist/models/order.d.ts:31 ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = `"requires_action"` +• **REQUIRES\_ACTION** = ``"requires_action"`` #### Defined in -packages/medusa/dist/models/order.d.ts:35 +medusa/dist/models/order.d.ts:36 ___ ### RETURNED -• **RETURNED** = `"returned"` +• **RETURNED** = ``"returned"`` #### Defined in -packages/medusa/dist/models/order.d.ts:33 +medusa/dist/models/order.d.ts:34 ___ ### SHIPPED -• **SHIPPED** = `"shipped"` +• **SHIPPED** = ``"shipped"`` #### Defined in -packages/medusa/dist/models/order.d.ts:31 +medusa/dist/models/order.d.ts:32 diff --git a/docs/content/references/js-client/enums/internal.OrderStatus.md b/docs/content/references/js-client/enums/internal.OrderStatus.md index 55ab50baa3..3522f4f647 100644 --- a/docs/content/references/js-client/enums/internal.OrderStatus.md +++ b/docs/content/references/js-client/enums/internal.OrderStatus.md @@ -6,52 +6,52 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).OrderStatus -## Enumeration members +## Enumeration Members ### ARCHIVED -• **ARCHIVED** = `"archived"` +• **ARCHIVED** = ``"archived"`` #### Defined in -packages/medusa/dist/models/order.d.ts:22 +medusa/dist/models/order.d.ts:23 ___ ### CANCELED -• **CANCELED** = `"canceled"` +• **CANCELED** = ``"canceled"`` #### Defined in -packages/medusa/dist/models/order.d.ts:23 +medusa/dist/models/order.d.ts:24 ___ ### COMPLETED -• **COMPLETED** = `"completed"` +• **COMPLETED** = ``"completed"`` #### Defined in -packages/medusa/dist/models/order.d.ts:21 +medusa/dist/models/order.d.ts:22 ___ ### PENDING -• **PENDING** = `"pending"` +• **PENDING** = ``"pending"`` #### Defined in -packages/medusa/dist/models/order.d.ts:20 +medusa/dist/models/order.d.ts:21 ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = `"requires_action"` +• **REQUIRES\_ACTION** = ``"requires_action"`` #### Defined in -packages/medusa/dist/models/order.d.ts:24 +medusa/dist/models/order.d.ts:25 diff --git a/docs/content/references/js-client/enums/internal.PaymentStatus.md b/docs/content/references/js-client/enums/internal.PaymentStatus.md index 40260dff5e..f0529bb78e 100644 --- a/docs/content/references/js-client/enums/internal.PaymentStatus.md +++ b/docs/content/references/js-client/enums/internal.PaymentStatus.md @@ -6,72 +6,72 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).PaymentStatus -## Enumeration members +## Enumeration Members ### AWAITING -• **AWAITING** = `"awaiting"` +• **AWAITING** = ``"awaiting"`` #### Defined in -packages/medusa/dist/models/order.d.ts:39 +medusa/dist/models/order.d.ts:40 ___ ### CANCELED -• **CANCELED** = `"canceled"` +• **CANCELED** = ``"canceled"`` #### Defined in -packages/medusa/dist/models/order.d.ts:43 +medusa/dist/models/order.d.ts:44 ___ ### CAPTURED -• **CAPTURED** = `"captured"` +• **CAPTURED** = ``"captured"`` #### Defined in -packages/medusa/dist/models/order.d.ts:40 +medusa/dist/models/order.d.ts:41 ___ ### NOT\_PAID -• **NOT\_PAID** = `"not_paid"` +• **NOT\_PAID** = ``"not_paid"`` #### Defined in -packages/medusa/dist/models/order.d.ts:38 +medusa/dist/models/order.d.ts:39 ___ ### PARTIALLY\_REFUNDED -• **PARTIALLY\_REFUNDED** = `"partially_refunded"` +• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` #### Defined in -packages/medusa/dist/models/order.d.ts:41 +medusa/dist/models/order.d.ts:42 ___ ### REFUNDED -• **REFUNDED** = `"refunded"` +• **REFUNDED** = ``"refunded"`` #### Defined in -packages/medusa/dist/models/order.d.ts:42 +medusa/dist/models/order.d.ts:43 ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = `"requires_action"` +• **REQUIRES\_ACTION** = ``"requires_action"`` #### Defined in -packages/medusa/dist/models/order.d.ts:44 +medusa/dist/models/order.d.ts:45 diff --git a/docs/content/references/js-client/enums/internal.PriceListStatus.md b/docs/content/references/js-client/enums/internal.PriceListStatus.md index edbbadb4b5..09e4ddc9e9 100644 --- a/docs/content/references/js-client/enums/internal.PriceListStatus.md +++ b/docs/content/references/js-client/enums/internal.PriceListStatus.md @@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).PriceListStatus -## Enumeration members +## Enumeration Members ### ACTIVE -• **ACTIVE** = `"active"` +• **ACTIVE** = ``"active"`` #### Defined in -packages/medusa/dist/types/price-list.d.ts:8 +medusa/dist/types/price-list.d.ts:8 ___ ### DRAFT -• **DRAFT** = `"draft"` +• **DRAFT** = ``"draft"`` #### Defined in -packages/medusa/dist/types/price-list.d.ts:9 +medusa/dist/types/price-list.d.ts:9 diff --git a/docs/content/references/js-client/enums/internal.PriceListType.md b/docs/content/references/js-client/enums/internal.PriceListType.md index 3d50b0fdc3..f53290c120 100644 --- a/docs/content/references/js-client/enums/internal.PriceListType.md +++ b/docs/content/references/js-client/enums/internal.PriceListType.md @@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).PriceListType -## Enumeration members +## Enumeration Members ### OVERRIDE -• **OVERRIDE** = `"override"` +• **OVERRIDE** = ``"override"`` #### Defined in -packages/medusa/dist/types/price-list.d.ts:5 +medusa/dist/types/price-list.d.ts:5 ___ ### SALE -• **SALE** = `"sale"` +• **SALE** = ``"sale"`` #### Defined in -packages/medusa/dist/types/price-list.d.ts:4 +medusa/dist/types/price-list.d.ts:4 diff --git a/docs/content/references/js-client/enums/internal.ProductStatus.md b/docs/content/references/js-client/enums/internal.ProductStatus.md index 414e4c7681..b2ae46e269 100644 --- a/docs/content/references/js-client/enums/internal.ProductStatus.md +++ b/docs/content/references/js-client/enums/internal.ProductStatus.md @@ -6,42 +6,42 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ProductStatus -## Enumeration members +## Enumeration Members ### DRAFT -• **DRAFT** = `"draft"` +• **DRAFT** = ``"draft"`` #### Defined in -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:54 +medusa/dist/models/product.d.ts:11 ___ ### PROPOSED -• **PROPOSED** = `"proposed"` +• **PROPOSED** = ``"proposed"`` #### Defined in -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:55 +medusa/dist/models/product.d.ts:12 ___ ### PUBLISHED -• **PUBLISHED** = `"published"` +• **PUBLISHED** = ``"published"`` #### Defined in -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:56 +medusa/dist/models/product.d.ts:13 ___ ### REJECTED -• **REJECTED** = `"rejected"` +• **REJECTED** = ``"rejected"`` #### Defined in -packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:57 +medusa/dist/models/product.d.ts:14 diff --git a/docs/content/references/js-client/enums/internal.RequirementType.md b/docs/content/references/js-client/enums/internal.RequirementType.md index 3afc6df8ab..d182fdcf7d 100644 --- a/docs/content/references/js-client/enums/internal.RequirementType.md +++ b/docs/content/references/js-client/enums/internal.RequirementType.md @@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).RequirementType -## Enumeration members +## Enumeration Members ### MAX\_SUBTOTAL -• **MAX\_SUBTOTAL** = `"max_subtotal"` +• **MAX\_SUBTOTAL** = ``"max_subtotal"`` #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:4 +medusa/dist/models/shipping-option-requirement.d.ts:4 ___ ### MIN\_SUBTOTAL -• **MIN\_SUBTOTAL** = `"min_subtotal"` +• **MIN\_SUBTOTAL** = ``"min_subtotal"`` #### Defined in -packages/medusa/dist/models/shipping-option-requirement.d.ts:3 +medusa/dist/models/shipping-option-requirement.d.ts:3 diff --git a/docs/content/references/js-client/enums/internal.ReturnStatus.md b/docs/content/references/js-client/enums/internal.ReturnStatus.md index 3e46681fe3..705558ef55 100644 --- a/docs/content/references/js-client/enums/internal.ReturnStatus.md +++ b/docs/content/references/js-client/enums/internal.ReturnStatus.md @@ -6,42 +6,42 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ReturnStatus -## Enumeration members +## Enumeration Members ### CANCELED -• **CANCELED** = `"canceled"` +• **CANCELED** = ``"canceled"`` #### Defined in -packages/medusa/dist/models/return.d.ts:11 +medusa/dist/models/return.d.ts:11 ___ ### RECEIVED -• **RECEIVED** = `"received"` +• **RECEIVED** = ``"received"`` #### Defined in -packages/medusa/dist/models/return.d.ts:9 +medusa/dist/models/return.d.ts:9 ___ ### REQUESTED -• **REQUESTED** = `"requested"` +• **REQUESTED** = ``"requested"`` #### Defined in -packages/medusa/dist/models/return.d.ts:8 +medusa/dist/models/return.d.ts:8 ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = `"requires_action"` +• **REQUIRES\_ACTION** = ``"requires_action"`` #### Defined in -packages/medusa/dist/models/return.d.ts:10 +medusa/dist/models/return.d.ts:10 diff --git a/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md b/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md index 2c3694c4b6..532ca4aa9d 100644 --- a/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md +++ b/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md @@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ShippingOptionPriceType -## Enumeration members +## Enumeration Members ### CALCULATED -• **CALCULATED** = `"calculated"` +• **CALCULATED** = ``"calculated"`` #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:8 +medusa/dist/models/shipping-option.d.ts:8 ___ ### FLAT\_RATE -• **FLAT\_RATE** = `"flat_rate"` +• **FLAT\_RATE** = ``"flat_rate"`` #### Defined in -packages/medusa/dist/models/shipping-option.d.ts:7 +medusa/dist/models/shipping-option.d.ts:7 diff --git a/docs/content/references/js-client/enums/internal.ShippingProfileType.md b/docs/content/references/js-client/enums/internal.ShippingProfileType.md index 5ff5818600..d232a74207 100644 --- a/docs/content/references/js-client/enums/internal.ShippingProfileType.md +++ b/docs/content/references/js-client/enums/internal.ShippingProfileType.md @@ -6,32 +6,32 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).ShippingProfileType -## Enumeration members +## Enumeration Members ### CUSTOM -• **CUSTOM** = `"custom"` +• **CUSTOM** = ``"custom"`` #### Defined in -packages/medusa/dist/models/shipping-profile.d.ts:7 +medusa/dist/models/shipping-profile.d.ts:7 ___ ### DEFAULT -• **DEFAULT** = `"default"` +• **DEFAULT** = ``"default"`` #### Defined in -packages/medusa/dist/models/shipping-profile.d.ts:5 +medusa/dist/models/shipping-profile.d.ts:5 ___ ### GIFT\_CARD -• **GIFT\_CARD** = `"gift_card"` +• **GIFT\_CARD** = ``"gift_card"`` #### Defined in -packages/medusa/dist/models/shipping-profile.d.ts:6 +medusa/dist/models/shipping-profile.d.ts:6 diff --git a/docs/content/references/js-client/enums/internal.Status.md b/docs/content/references/js-client/enums/internal.Status.md deleted file mode 100644 index ed474bf2ee..0000000000 --- a/docs/content/references/js-client/enums/internal.Status.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: Status - -[internal](../modules/internal.md).Status - -## Enumeration members - -### DRAFT - -• **DRAFT** = `"draft"` - -#### Defined in - -packages/medusa/dist/models/product.d.ts:10 - -___ - -### PROPOSED - -• **PROPOSED** = `"proposed"` - -#### Defined in - -packages/medusa/dist/models/product.d.ts:11 - -___ - -### PUBLISHED - -• **PUBLISHED** = `"published"` - -#### Defined in - -packages/medusa/dist/models/product.d.ts:12 - -___ - -### REJECTED - -• **REJECTED** = `"rejected"` - -#### Defined in - -packages/medusa/dist/models/product.d.ts:13 diff --git a/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md b/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md index b0ef31f55f..febdd04917 100644 --- a/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md +++ b/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md @@ -6,52 +6,52 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).SwapFulfillmentStatus -## Enumeration members +## Enumeration Members ### CANCELED -• **CANCELED** = `"canceled"` +• **CANCELED** = ``"canceled"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:14 +medusa/dist/models/swap.d.ts:14 ___ ### FULFILLED -• **FULFILLED** = `"fulfilled"` +• **FULFILLED** = ``"fulfilled"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:12 +medusa/dist/models/swap.d.ts:12 ___ ### NOT\_FULFILLED -• **NOT\_FULFILLED** = `"not_fulfilled"` +• **NOT\_FULFILLED** = ``"not_fulfilled"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:11 +medusa/dist/models/swap.d.ts:11 ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = `"requires_action"` +• **REQUIRES\_ACTION** = ``"requires_action"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:15 +medusa/dist/models/swap.d.ts:15 ___ ### SHIPPED -• **SHIPPED** = `"shipped"` +• **SHIPPED** = ``"shipped"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:13 +medusa/dist/models/swap.d.ts:13 diff --git a/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md b/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md index 9485189c78..c6ae33d95f 100644 --- a/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md +++ b/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md @@ -6,92 +6,92 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).SwapPaymentStatus -## Enumeration members +## Enumeration Members ### AWAITING -• **AWAITING** = `"awaiting"` +• **AWAITING** = ``"awaiting"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:19 +medusa/dist/models/swap.d.ts:19 ___ ### CANCELED -• **CANCELED** = `"canceled"` +• **CANCELED** = ``"canceled"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:22 +medusa/dist/models/swap.d.ts:22 ___ ### CAPTURED -• **CAPTURED** = `"captured"` +• **CAPTURED** = ``"captured"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:20 +medusa/dist/models/swap.d.ts:20 ___ ### CONFIRMED -• **CONFIRMED** = `"confirmed"` +• **CONFIRMED** = ``"confirmed"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:21 +medusa/dist/models/swap.d.ts:21 ___ ### DIFFERENCE\_REFUNDED -• **DIFFERENCE\_REFUNDED** = `"difference_refunded"` +• **DIFFERENCE\_REFUNDED** = ``"difference_refunded"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:23 +medusa/dist/models/swap.d.ts:23 ___ ### NOT\_PAID -• **NOT\_PAID** = `"not_paid"` +• **NOT\_PAID** = ``"not_paid"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:18 +medusa/dist/models/swap.d.ts:18 ___ ### PARTIALLY\_REFUNDED -• **PARTIALLY\_REFUNDED** = `"partially_refunded"` +• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:24 +medusa/dist/models/swap.d.ts:24 ___ ### REFUNDED -• **REFUNDED** = `"refunded"` +• **REFUNDED** = ``"refunded"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:25 +medusa/dist/models/swap.d.ts:25 ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = `"requires_action"` +• **REQUIRES\_ACTION** = ``"requires_action"`` #### Defined in -packages/medusa/dist/models/swap.d.ts:26 +medusa/dist/models/swap.d.ts:26 diff --git a/docs/content/references/js-client/enums/internal.UserRoles.md b/docs/content/references/js-client/enums/internal.UserRoles.md deleted file mode 100644 index fdad68f0e8..0000000000 --- a/docs/content/references/js-client/enums/internal.UserRoles.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Enumeration: UserRoles - -[internal](../modules/internal.md).UserRoles - -## Enumeration members - -### ADMIN - -• **ADMIN** = `"admin"` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:3 - -___ - -### DEVELOPER - -• **DEVELOPER** = `"developer"` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:5 - -___ - -### MEMBER - -• **MEMBER** = `"member"` - -#### Defined in - -packages/medusa/dist/models/user.d.ts:4 diff --git a/docs/content/references/js-client/index.md b/docs/content/references/js-client/index.md index 2d56c916ad..b7b19e0745 100644 --- a/docs/content/references/js-client/index.md +++ b/docs/content/references/js-client/index.md @@ -3,53 +3,56 @@ ## Namespaces - [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) -- [internal](modules/internal.md) +- [internal](modules/internal-1.md) +- [internal](modules/internal-2.md) +- [internal](modules/internal-3.md) +- [internal](modules/internal-4.md) +- [internal](modules/internal-5.md) +- [internal](modules/internal-6.md) +- [internal](modules/internal-7.md) +- [internal](modules/internal-8.md) +- [internal](modules/internal-9.md) +- [internal](modules/internal-10.md) +- [internal](modules/internal-11.md) +- [internal](modules/internal-12.md) +- [internal](modules/internal-13.md) +- [internal](modules/internal-14.md) +- [internal](modules/internal-15.md) +- [internal](modules/internal-16.md) +- [internal](modules/internal-17.md) +- [internal](modules/internal-18.md) +- [internal](modules/internal-19.md) +- [internal](modules/internal-20.md) +- [internal](modules/internal-21.md) +- [internal](modules/internal-22.md) +- [internal](modules/internal-23.md) +- [internal](modules/internal-24.md) +- [internal](modules/internal-25.md) +- [internal](modules/internal-26.md) +- [internal](modules/internal-27.md) +- [internal](modules/internal-28.md) +- [internal](modules/internal-29.md) +- [internal](modules/internal-30.md) +- [internal](modules/internal-31.md) +- [internal](modules/internal-32.md) +- [internal](modules/internal-33.md) +- [internal](modules/internal-34.md) +- [internal](modules/internal-35.md) +- [internal](modules/internal-36.md) +- [internal](modules/internal-37.md) +- [internal](modules/internal-38.md) +- [internal](modules/internal-39.md) +- [internal](modules/internal-40.md) +- [internal](modules/internal-41.md) +- [internal](modules/internal-42.md) +- [internal](modules/internal-43.md) ## Classes - [AddressesResource](classes/AddressesResource.md) - [Admin](classes/Admin.md) - [AdminAuthResource](classes/AdminAuthResource.md) +- [AdminBatchJobsResource](classes/AdminBatchJobsResource.md) - [AdminCollectionsResource](classes/AdminCollectionsResource.md) - [AdminCustomerGroupsResource](classes/AdminCustomerGroupsResource.md) - [AdminCustomersResource](classes/AdminCustomersResource.md) @@ -67,6 +70,7 @@ - [AdminRegionsResource](classes/AdminRegionsResource.md) - [AdminReturnReasonsResource](classes/AdminReturnReasonsResource.md) - [AdminReturnsResource](classes/AdminReturnsResource.md) +- [AdminSalesChannelsResource](classes/AdminSalesChannelsResource.md) - [AdminShippingOptionsResource](classes/AdminShippingOptionsResource.md) - [AdminShippingProfilesResource](classes/AdminShippingProfilesResource.md) - [AdminStoresResource](classes/AdminStoresResource.md) diff --git a/docs/content/references/js-client/interfaces/internal.AbortSignal.md b/docs/content/references/js-client/interfaces/internal.AbortSignal.md deleted file mode 100644 index 6e039d7b4e..0000000000 --- a/docs/content/references/js-client/interfaces/internal.AbortSignal.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AbortSignal - -[internal](../modules/internal.md).AbortSignal - -A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object. - -## Properties - -### aborted - -• `Readonly` **aborted**: `boolean` - -Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise. - -#### Defined in - -node_modules/@types/node/globals.d.ts:64 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md b/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md index 862239771e..c90b73fc6c 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md @@ -24,4 +24,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:18 +medusa-js/node_modules/axios/index.d.ts:18 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md b/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md index ae9075abb3..eeb5f4899e 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:23 +medusa-js/node_modules/axios/index.d.ts:23 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:22 +medusa-js/node_modules/axios/index.d.ts:22 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md b/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md index e5abadab97..f38e5e12e5 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar ## Hierarchy -- [`Omit`](../modules/internal.md#omit)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>, ``"headers"``\> +- `Omit`<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>, ``"headers"``\> ↳ **`AxiosDefaults`** @@ -30,7 +30,7 @@ Omit.adapter #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:75 +medusa-js/node_modules/axios/index.d.ts:75 ___ @@ -44,7 +44,7 @@ Omit.auth #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:76 +medusa-js/node_modules/axios/index.d.ts:76 ___ @@ -58,7 +58,7 @@ Omit.baseURL #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:65 +medusa-js/node_modules/axios/index.d.ts:65 ___ @@ -72,7 +72,7 @@ Omit.cancelToken #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:90 +medusa-js/node_modules/axios/index.d.ts:90 ___ @@ -86,7 +86,7 @@ Omit.data #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:71 +medusa-js/node_modules/axios/index.d.ts:71 ___ @@ -100,7 +100,7 @@ Omit.decompress #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:91 +medusa-js/node_modules/axios/index.d.ts:91 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:112 +medusa-js/node_modules/axios/index.d.ts:112 ___ @@ -124,7 +124,7 @@ Omit.httpAgent #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:87 +medusa-js/node_modules/axios/index.d.ts:87 ___ @@ -138,7 +138,7 @@ Omit.httpsAgent #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:88 +medusa-js/node_modules/axios/index.d.ts:88 ___ @@ -152,7 +152,7 @@ Omit.insecureHTTPParser #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:94 +medusa-js/node_modules/axios/index.d.ts:94 ___ @@ -166,7 +166,7 @@ Omit.maxBodyLength #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:84 +medusa-js/node_modules/axios/index.d.ts:84 ___ @@ -180,7 +180,7 @@ Omit.maxContentLength #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:82 +medusa-js/node_modules/axios/index.d.ts:82 ___ @@ -194,7 +194,7 @@ Omit.maxRedirects #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:85 +medusa-js/node_modules/axios/index.d.ts:85 ___ @@ -208,7 +208,63 @@ Omit.method #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:64 +medusa-js/node_modules/axios/index.d.ts:64 + +___ + +### onDownloadProgress + +• `Optional` **onDownloadProgress**: (`progressEvent`: `any`) => `void` + +#### Type declaration + +▸ (`progressEvent`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `progressEvent` | `any` | + +##### Returns + +`void` + +#### Inherited from + +Omit.onDownloadProgress + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:81 + +___ + +### onUploadProgress + +• `Optional` **onUploadProgress**: (`progressEvent`: `any`) => `void` + +#### Type declaration + +▸ (`progressEvent`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `progressEvent` | `any` | + +##### Returns + +`void` + +#### Inherited from + +Omit.onUploadProgress + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:80 ___ @@ -222,7 +278,35 @@ Omit.params #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:69 +medusa-js/node_modules/axios/index.d.ts:69 + +___ + +### paramsSerializer + +• `Optional` **paramsSerializer**: (`params`: `any`) => `string` + +#### Type declaration + +▸ (`params`): `string` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `any` | + +##### Returns + +`string` + +#### Inherited from + +Omit.paramsSerializer + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:70 ___ @@ -236,7 +320,7 @@ Omit.proxy #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:89 +medusa-js/node_modules/axios/index.d.ts:89 ___ @@ -250,7 +334,7 @@ Omit.raxConfig #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 ___ @@ -264,13 +348,13 @@ Omit.responseType #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:77 +medusa-js/node_modules/axios/index.d.ts:77 ___ ### signal -• `Optional` **signal**: [`AbortSignal`](../modules/internal.md#abortsignal) +• `Optional` **signal**: `AbortSignal` #### Inherited from @@ -278,7 +362,7 @@ Omit.signal #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:93 +medusa-js/node_modules/axios/index.d.ts:93 ___ @@ -292,7 +376,7 @@ Omit.socketPath #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:86 +medusa-js/node_modules/axios/index.d.ts:86 ___ @@ -306,7 +390,7 @@ Omit.timeout #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:72 +medusa-js/node_modules/axios/index.d.ts:72 ___ @@ -320,7 +404,7 @@ Omit.timeoutErrorMessage #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:73 +medusa-js/node_modules/axios/index.d.ts:73 ___ @@ -334,7 +418,7 @@ Omit.transformRequest #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:66 +medusa-js/node_modules/axios/index.d.ts:66 ___ @@ -348,7 +432,7 @@ Omit.transformResponse #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:67 +medusa-js/node_modules/axios/index.d.ts:67 ___ @@ -362,7 +446,7 @@ Omit.transitional #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:92 +medusa-js/node_modules/axios/index.d.ts:92 ___ @@ -376,7 +460,7 @@ Omit.url #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:63 +medusa-js/node_modules/axios/index.d.ts:63 ___ @@ -390,7 +474,7 @@ Omit.validateStatus #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:83 +medusa-js/node_modules/axios/index.d.ts:83 ___ @@ -404,7 +488,7 @@ Omit.withCredentials #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:74 +medusa-js/node_modules/axios/index.d.ts:74 ___ @@ -418,7 +502,7 @@ Omit.xsrfCookieName #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:78 +medusa-js/node_modules/axios/index.d.ts:78 ___ @@ -432,76 +516,4 @@ Omit.xsrfHeaderName #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:79 - -## Methods - -### onDownloadProgress - -▸ `Optional` **onDownloadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Inherited from - -Omit.onDownloadProgress - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:81 - -___ - -### onUploadProgress - -▸ `Optional` **onUploadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Inherited from - -Omit.onUploadProgress - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:80 - -___ - -### paramsSerializer - -▸ `Optional` **paramsSerializer**(`params`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `any` | - -#### Returns - -`string` - -#### Inherited from - -Omit.paramsSerializer - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:70 +medusa-js/node_modules/axios/index.d.ts:79 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosError.md b/docs/content/references/js-client/interfaces/internal.AxiosError.md index 7513419e68..9b84115527 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosError.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosError.md @@ -15,7 +15,7 @@ displayed_sidebar: jsClientSidebar ## Hierarchy -- [`Error`](../modules/internal.md#error) +- `Error` ↳ **`AxiosError`** @@ -27,7 +27,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:126 +medusa-js/node_modules/axios/index.d.ts:126 ___ @@ -37,7 +37,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:125 +medusa-js/node_modules/axios/index.d.ts:125 ___ @@ -47,35 +47,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:129 - -___ - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1023 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1022 +medusa-js/node_modules/axios/index.d.ts:129 ___ @@ -85,7 +57,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:127 +medusa-js/node_modules/axios/index.d.ts:127 ___ @@ -95,32 +67,22 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:128 +medusa-js/node_modules/axios/index.d.ts:128 ___ -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1024 - -## Methods - ### toJSON -▸ **toJSON**(): `object` +• **toJSON**: () => `object` -#### Returns +#### Type declaration + +▸ (): `object` + +##### Returns `object` #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:130 +medusa-js/node_modules/axios/index.d.ts:130 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosInstance.md b/docs/content/references/js-client/interfaces/internal.AxiosInstance.md index e9c6af1fba..54eefcb704 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosInstance.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosInstance.md @@ -30,7 +30,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:188 +medusa-js/node_modules/axios/index.d.ts:188 ### AxiosInstance @@ -49,7 +49,7 @@ packages/medusa-js/node_modules/axios/index.d.ts:188 #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:189 +medusa-js/node_modules/axios/index.d.ts:189 ## Properties @@ -63,7 +63,7 @@ packages/medusa-js/node_modules/axios/index.d.ts:189 #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:171 +medusa-js/node_modules/axios/index.d.ts:171 ___ @@ -84,13 +84,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:172 +medusa-js/node_modules/axios/index.d.ts:172 ## Methods ### delete -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> #### Type parameters @@ -109,7 +109,7 @@ packages/medusa-js/node_modules/axios/index.d.ts:172 #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Inherited from @@ -117,13 +117,13 @@ packages/medusa-js/node_modules/axios/index.d.ts:172 #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:179 +medusa-js/node_modules/axios/index.d.ts:179 ___ ### get -▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> #### Type parameters @@ -142,7 +142,7 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Inherited from @@ -150,7 +150,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:178 +medusa-js/node_modules/axios/index.d.ts:178 ___ @@ -174,13 +174,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:176 +medusa-js/node_modules/axios/index.d.ts:176 ___ ### head -▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> #### Type parameters @@ -199,7 +199,7 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Inherited from @@ -207,13 +207,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:180 +medusa-js/node_modules/axios/index.d.ts:180 ___ ### options -▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> #### Type parameters @@ -232,7 +232,7 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Inherited from @@ -240,13 +240,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:181 +medusa-js/node_modules/axios/index.d.ts:181 ___ ### patch -▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> #### Type parameters @@ -266,7 +266,7 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Inherited from @@ -274,13 +274,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:184 +medusa-js/node_modules/axios/index.d.ts:184 ___ ### post -▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> #### Type parameters @@ -300,7 +300,7 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Inherited from @@ -308,13 +308,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:182 +medusa-js/node_modules/axios/index.d.ts:182 ___ ### put -▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> #### Type parameters @@ -334,7 +334,7 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Inherited from @@ -342,13 +342,13 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:183 +medusa-js/node_modules/axios/index.d.ts:183 ___ ### request -▸ **request**<`T`, `R`, `D`\>(`config`): [`Promise`](../modules/internal.md#promise)<`R`\> +▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> #### Type parameters @@ -366,7 +366,7 @@ ___ #### Returns -[`Promise`](../modules/internal.md#promise)<`R`\> +`Promise`<`R`\> #### Inherited from @@ -374,4 +374,4 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:177 +medusa-js/node_modules/axios/index.d.ts:177 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md b/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md index 2df8a4679a..c4d4e53445 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md @@ -30,7 +30,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:166 +medusa-js/node_modules/axios/index.d.ts:166 ___ @@ -48,7 +48,7 @@ ___ | Name | Type | | :------ | :------ | -| `onFulfilled?` | (`value`: `V`) => `T` \| [`Promise`](../modules/internal.md#promise)<`T`\> | +| `onFulfilled?` | (`value`: `V`) => `T` \| `Promise`<`T`\> | | `onRejected?` | (`error`: `any`) => `any` | #### Returns @@ -57,4 +57,4 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:165 +medusa-js/node_modules/axios/index.d.ts:165 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosPromise.md b/docs/content/references/js-client/interfaces/internal.AxiosPromise.md index 03b239236e..78ca097838 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosPromise.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosPromise.md @@ -14,119 +14,6 @@ displayed_sidebar: jsClientSidebar ## Hierarchy -- [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`\>\> +- `Promise`<[`AxiosResponse`](internal.AxiosResponse.md)<`T`\>\> ↳ **`AxiosPromise`** - -## Properties - -### [toStringTag] - -• `Readonly` **[toStringTag]**: `string` - -#### Inherited from - -Promise.\_\_@toStringTag@311 - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174 - -## Methods - -### catch - -▸ **catch**<`TResult`\>(`onrejected?`): [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> - -Attaches a callback for only the rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> - -A Promise for the completion of the callback. - -#### Inherited from - -Promise.catch - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1509 - -___ - -### finally - -▸ **finally**(`onfinally?`): [`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\>\> - -Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The -resolved value cannot be modified from the callback. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfinally?` | ``null`` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<[`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\>\> - -A Promise for the completion of the callback. - -#### Inherited from - -Promise.finally - -#### Defined in - -node_modules/typescript/lib/lib.es2018.promise.d.ts:31 - -___ - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\>) => `TResult1` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Inherited from - -Promise.then - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1502 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md b/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md index c8380da09e..0b5ea3c7c6 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md @@ -21,7 +21,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:29 +medusa-js/node_modules/axios/index.d.ts:29 ___ @@ -31,7 +31,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:27 +medusa-js/node_modules/axios/index.d.ts:27 ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:28 +medusa-js/node_modules/axios/index.d.ts:28 ___ @@ -51,4 +51,4 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:33 +medusa-js/node_modules/axios/index.d.ts:33 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md b/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md index d14d710596..a6fa001109 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md @@ -20,7 +20,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:75 +medusa-js/node_modules/axios/index.d.ts:75 ___ @@ -30,7 +30,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:76 +medusa-js/node_modules/axios/index.d.ts:76 ___ @@ -40,7 +40,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:65 +medusa-js/node_modules/axios/index.d.ts:65 ___ @@ -50,7 +50,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:90 +medusa-js/node_modules/axios/index.d.ts:90 ___ @@ -60,7 +60,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:71 +medusa-js/node_modules/axios/index.d.ts:71 ___ @@ -70,7 +70,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:91 +medusa-js/node_modules/axios/index.d.ts:91 ___ @@ -80,7 +80,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:68 +medusa-js/node_modules/axios/index.d.ts:68 ___ @@ -90,7 +90,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:87 +medusa-js/node_modules/axios/index.d.ts:87 ___ @@ -100,7 +100,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:88 +medusa-js/node_modules/axios/index.d.ts:88 ___ @@ -110,7 +110,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:94 +medusa-js/node_modules/axios/index.d.ts:94 ___ @@ -120,7 +120,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:84 +medusa-js/node_modules/axios/index.d.ts:84 ___ @@ -130,7 +130,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:82 +medusa-js/node_modules/axios/index.d.ts:82 ___ @@ -140,7 +140,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:85 +medusa-js/node_modules/axios/index.d.ts:85 ___ @@ -150,7 +150,55 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:64 +medusa-js/node_modules/axios/index.d.ts:64 + +___ + +### onDownloadProgress + +• `Optional` **onDownloadProgress**: (`progressEvent`: `any`) => `void` + +#### Type declaration + +▸ (`progressEvent`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `progressEvent` | `any` | + +##### Returns + +`void` + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:81 + +___ + +### onUploadProgress + +• `Optional` **onUploadProgress**: (`progressEvent`: `any`) => `void` + +#### Type declaration + +▸ (`progressEvent`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `progressEvent` | `any` | + +##### Returns + +`void` + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:80 ___ @@ -160,7 +208,31 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:69 +medusa-js/node_modules/axios/index.d.ts:69 + +___ + +### paramsSerializer + +• `Optional` **paramsSerializer**: (`params`: `any`) => `string` + +#### Type declaration + +▸ (`params`): `string` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `any` | + +##### Returns + +`string` + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:70 ___ @@ -170,7 +242,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:89 +medusa-js/node_modules/axios/index.d.ts:89 ___ @@ -180,7 +252,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 ___ @@ -190,17 +262,17 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:77 +medusa-js/node_modules/axios/index.d.ts:77 ___ ### signal -• `Optional` **signal**: [`AbortSignal`](../modules/internal.md#abortsignal) +• `Optional` **signal**: `AbortSignal` #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:93 +medusa-js/node_modules/axios/index.d.ts:93 ___ @@ -210,7 +282,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:86 +medusa-js/node_modules/axios/index.d.ts:86 ___ @@ -220,7 +292,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:72 +medusa-js/node_modules/axios/index.d.ts:72 ___ @@ -230,7 +302,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:73 +medusa-js/node_modules/axios/index.d.ts:73 ___ @@ -240,7 +312,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:66 +medusa-js/node_modules/axios/index.d.ts:66 ___ @@ -250,7 +322,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:67 +medusa-js/node_modules/axios/index.d.ts:67 ___ @@ -260,7 +332,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:92 +medusa-js/node_modules/axios/index.d.ts:92 ___ @@ -270,7 +342,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:63 +medusa-js/node_modules/axios/index.d.ts:63 ___ @@ -280,7 +352,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:83 +medusa-js/node_modules/axios/index.d.ts:83 ___ @@ -290,7 +362,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:74 +medusa-js/node_modules/axios/index.d.ts:74 ___ @@ -300,7 +372,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:78 +medusa-js/node_modules/axios/index.d.ts:78 ___ @@ -310,64 +382,4 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:79 - -## Methods - -### onDownloadProgress - -▸ `Optional` **onDownloadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:81 - -___ - -### onUploadProgress - -▸ `Optional` **onUploadProgress**(`progressEvent`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -#### Returns - -`void` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:80 - -___ - -### paramsSerializer - -▸ `Optional` **paramsSerializer**(`params`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `any` | - -#### Returns - -`string` - -#### Defined in - -packages/medusa-js/node_modules/axios/index.d.ts:70 +medusa-js/node_modules/axios/index.d.ts:79 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md b/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md index 59aadba96e..693fb1de2d 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md @@ -25,4 +25,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:10 +medusa-js/node_modules/axios/index.d.ts:10 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosResponse.md b/docs/content/references/js-client/interfaces/internal.AxiosResponse.md index 62ff394b53..2c702796d1 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosResponse.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosResponse.md @@ -21,7 +21,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:120 +medusa-js/node_modules/axios/index.d.ts:120 ___ @@ -31,7 +31,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:116 +medusa-js/node_modules/axios/index.d.ts:116 ___ @@ -41,7 +41,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:119 +medusa-js/node_modules/axios/index.d.ts:119 ___ @@ -51,7 +51,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:121 +medusa-js/node_modules/axios/index.d.ts:121 ___ @@ -61,7 +61,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:117 +medusa-js/node_modules/axios/index.d.ts:117 ___ @@ -71,4 +71,4 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:118 +medusa-js/node_modules/axios/index.d.ts:118 diff --git a/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md b/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md index 5a6b5b4860..fd9b0a700d 100644 --- a/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md +++ b/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md @@ -25,4 +25,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:14 +medusa-js/node_modules/axios/index.d.ts:14 diff --git a/docs/content/references/js-client/interfaces/internal.CallSite.md b/docs/content/references/js-client/interfaces/internal.CallSite.md deleted file mode 100644 index b5f5ac73b7..0000000000 --- a/docs/content/references/js-client/interfaces/internal.CallSite.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: CallSite - -[internal](../modules/internal.md).CallSite - -## Methods - -### getColumnNumber - -▸ **getColumnNumber**(): ``null`` \| `number` - -Current column number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:154 - -___ - -### getEvalOrigin - -▸ **getEvalOrigin**(): `undefined` \| `string` - -A call site object representing the location where eval was called -[if this function was created using a call to eval] - -#### Returns - -`undefined` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:160 - -___ - -### getFileName - -▸ **getFileName**(): ``null`` \| `string` - -Name of the script [if this function was defined in a script] - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:144 - -___ - -### getFunction - -▸ **getFunction**(): `undefined` \| [`Function`](../modules/internal.md#function) - -Current function - -#### Returns - -`undefined` \| [`Function`](../modules/internal.md#function) - -#### Defined in - -node_modules/@types/node/globals.d.ts:126 - -___ - -### getFunctionName - -▸ **getFunctionName**(): ``null`` \| `string` - -Name of the current function, typically its name property. -If a name property is not available an attempt will be made to try -to infer a name from the function's context. - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:133 - -___ - -### getLineNumber - -▸ **getLineNumber**(): ``null`` \| `number` - -Current line number [if this function was defined in a script] - -#### Returns - -``null`` \| `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:149 - -___ - -### getMethodName - -▸ **getMethodName**(): ``null`` \| `string` - -Name of the property [of "this" or one of its prototypes] that holds -the current function - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:139 - -___ - -### getThis - -▸ **getThis**(): `unknown` - -Value of "this" - -#### Returns - -`unknown` - -#### Defined in - -node_modules/@types/node/globals.d.ts:113 - -___ - -### getTypeName - -▸ **getTypeName**(): ``null`` \| `string` - -Type of "this" as a string. -This is the name of the function stored in the constructor field of -"this", if available. Otherwise the object's [[Class]] internal -property. - -#### Returns - -``null`` \| `string` - -#### Defined in - -node_modules/@types/node/globals.d.ts:121 - -___ - -### isConstructor - -▸ **isConstructor**(): `boolean` - -Is this a constructor call? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:180 - -___ - -### isEval - -▸ **isEval**(): `boolean` - -Does this call take place in code defined by a call to eval? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:170 - -___ - -### isNative - -▸ **isNative**(): `boolean` - -Is this call in native V8 code? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:175 - -___ - -### isToplevel - -▸ **isToplevel**(): `boolean` - -Is this a toplevel invocation, that is, is "this" the global object? - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@types/node/globals.d.ts:165 diff --git a/docs/content/references/js-client/interfaces/internal.Cancel.md b/docs/content/references/js-client/interfaces/internal.Cancel.md index b9d3f0ddde..150d71e073 100644 --- a/docs/content/references/js-client/interfaces/internal.Cancel.md +++ b/docs/content/references/js-client/interfaces/internal.Cancel.md @@ -14,4 +14,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:141 +medusa-js/node_modules/axios/index.d.ts:141 diff --git a/docs/content/references/js-client/interfaces/internal.CancelToken.md b/docs/content/references/js-client/interfaces/internal.CancelToken.md index fa8a9347d0..fc8cfb25e2 100644 --- a/docs/content/references/js-client/interfaces/internal.CancelToken.md +++ b/docs/content/references/js-client/interfaces/internal.CancelToken.md @@ -10,11 +10,11 @@ displayed_sidebar: jsClientSidebar ### promise -• **promise**: [`Promise`](../modules/internal.md#promise)<[`Cancel`](internal.Cancel.md)\> +• **promise**: `Promise`<[`Cancel`](internal.Cancel.md)\> #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:154 +medusa-js/node_modules/axios/index.d.ts:154 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:155 +medusa-js/node_modules/axios/index.d.ts:155 ## Methods @@ -38,4 +38,4 @@ packages/medusa-js/node_modules/axios/index.d.ts:155 #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:156 +medusa-js/node_modules/axios/index.d.ts:156 diff --git a/docs/content/references/js-client/interfaces/internal.Config.md b/docs/content/references/js-client/interfaces/internal.Config.md index 4a8f1ab709..fb32c689c7 100644 --- a/docs/content/references/js-client/interfaces/internal.Config.md +++ b/docs/content/references/js-client/interfaces/internal.Config.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -[packages/medusa-js/src/request.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L14) +[medusa-js/src/request.ts:14](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L14) ___ @@ -24,7 +24,7 @@ ___ #### Defined in -[packages/medusa-js/src/request.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L12) +[medusa-js/src/request.ts:12](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L12) ___ @@ -34,4 +34,4 @@ ___ #### Defined in -[packages/medusa-js/src/request.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L13) +[medusa-js/src/request.ts:13](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L13) diff --git a/docs/content/references/js-client/interfaces/internal.Date.md b/docs/content/references/js-client/interfaces/internal.Date.md deleted file mode 100644 index 7c3550c8c5..0000000000 --- a/docs/content/references/js-client/interfaces/internal.Date.md +++ /dev/null @@ -1,948 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: Date - -[internal](../modules/internal.md).Date - -Enables basic storage and retrieval of dates and times. - -## Methods - -### [toPrimitive] - -▸ **[toPrimitive]**(`hint`): `string` - -Converts a Date object to a string. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hint` | ``"default"`` | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:114 - -▸ **[toPrimitive]**(`hint`): `string` - -Converts a Date object to a string. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hint` | ``"string"`` | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:118 - -▸ **[toPrimitive]**(`hint`): `number` - -Converts a Date object to a number. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `hint` | ``"number"`` | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:122 - -▸ **[toPrimitive]**(`hint`): `string` \| `number` - -Converts a Date object to a string or number. - -**`throws`** {TypeError} If 'hint' was given something other than "number", "string", or "default". - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hint` | `string` | The strings "number", "string", or "default" to specify what primitive to return. | - -#### Returns - -`string` \| `number` - -A number if 'hint' was "number", a string if 'hint' was "string" or "default". - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:131 - -___ - -### getDate - -▸ **getDate**(): `number` - -Gets the day-of-the-month, using local time. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:775 - -___ - -### getDay - -▸ **getDay**(): `number` - -Gets the day of the week, using local time. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:779 - -___ - -### getFullYear - -▸ **getFullYear**(): `number` - -Gets the year, using local time. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:767 - -___ - -### getHours - -▸ **getHours**(): `number` - -Gets the hours in a date, using local time. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:783 - -___ - -### getMilliseconds - -▸ **getMilliseconds**(): `number` - -Gets the milliseconds of a Date, using local time. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:795 - -___ - -### getMinutes - -▸ **getMinutes**(): `number` - -Gets the minutes of a Date object, using local time. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:787 - -___ - -### getMonth - -▸ **getMonth**(): `number` - -Gets the month, using local time. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:771 - -___ - -### getSeconds - -▸ **getSeconds**(): `number` - -Gets the seconds of a Date object, using local time. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:791 - -___ - -### getTime - -▸ **getTime**(): `number` - -Gets the time value in milliseconds. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:765 - -___ - -### getTimezoneOffset - -▸ **getTimezoneOffset**(): `number` - -Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:799 - -___ - -### getUTCDate - -▸ **getUTCDate**(): `number` - -Gets the day-of-the-month, using Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:777 - -___ - -### getUTCDay - -▸ **getUTCDay**(): `number` - -Gets the day of the week using Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:781 - -___ - -### getUTCFullYear - -▸ **getUTCFullYear**(): `number` - -Gets the year using Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:769 - -___ - -### getUTCHours - -▸ **getUTCHours**(): `number` - -Gets the hours value in a Date object using Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:785 - -___ - -### getUTCMilliseconds - -▸ **getUTCMilliseconds**(): `number` - -Gets the milliseconds of a Date object using Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:797 - -___ - -### getUTCMinutes - -▸ **getUTCMinutes**(): `number` - -Gets the minutes of a Date object using Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:789 - -___ - -### getUTCMonth - -▸ **getUTCMonth**(): `number` - -Gets the month of a Date object using Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:773 - -___ - -### getUTCSeconds - -▸ **getUTCSeconds**(): `number` - -Gets the seconds of a Date object using Universal Coordinated Time (UTC). - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:793 - -___ - -### setDate - -▸ **setDate**(`date`): `number` - -Sets the numeric day-of-the-month value of the Date object using local time. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `date` | `number` | A numeric value equal to the day of the month. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:862 - -___ - -### setFullYear - -▸ **setFullYear**(`year`, `month?`, `date?`): `number` - -Sets the year of the Date object using local time. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `year` | `number` | A numeric value for the year. | -| `month?` | `number` | A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified. | -| `date?` | `number` | A numeric value equal for the day of the month. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:886 - -___ - -### setHours - -▸ **setHours**(`hours`, `min?`, `sec?`, `ms?`): `number` - -Sets the hour value in the Date object using local time. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hours` | `number` | A numeric value equal to the hours value. | -| `min?` | `number` | A numeric value equal to the minutes value. | -| `sec?` | `number` | A numeric value equal to the seconds value. | -| `ms?` | `number` | A numeric value equal to the milliseconds value. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:849 - -___ - -### setMilliseconds - -▸ **setMilliseconds**(`ms`): `number` - -Sets the milliseconds value in the Date object using local time. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ms` | `number` | A numeric value equal to the millisecond value. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:809 - -___ - -### setMinutes - -▸ **setMinutes**(`min`, `sec?`, `ms?`): `number` - -Sets the minutes value in the Date object using local time. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `min` | `number` | A numeric value equal to the minutes value. | -| `sec?` | `number` | A numeric value equal to the seconds value. | -| `ms?` | `number` | A numeric value equal to the milliseconds value. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:834 - -___ - -### setMonth - -▸ **setMonth**(`month`, `date?`): `number` - -Sets the month value in the Date object using local time. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `month` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. | -| `date?` | `number` | A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:873 - -___ - -### setSeconds - -▸ **setSeconds**(`sec`, `ms?`): `number` - -Sets the seconds value in the Date object using local time. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sec` | `number` | A numeric value equal to the seconds value. | -| `ms?` | `number` | A numeric value equal to the milliseconds value. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:821 - -___ - -### setTime - -▸ **setTime**(`time`): `number` - -Sets the date and time value in the Date object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `time` | `number` | A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:804 - -___ - -### setUTCDate - -▸ **setUTCDate**(`date`): `number` - -Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `date` | `number` | A numeric value equal to the day of the month. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:867 - -___ - -### setUTCFullYear - -▸ **setUTCFullYear**(`year`, `month?`, `date?`): `number` - -Sets the year value in the Date object using Universal Coordinated Time (UTC). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `year` | `number` | A numeric value equal to the year. | -| `month?` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied. | -| `date?` | `number` | A numeric value equal to the day of the month. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:893 - -___ - -### setUTCHours - -▸ **setUTCHours**(`hours`, `min?`, `sec?`, `ms?`): `number` - -Sets the hours value in the Date object using Universal Coordinated Time (UTC). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hours` | `number` | A numeric value equal to the hours value. | -| `min?` | `number` | A numeric value equal to the minutes value. | -| `sec?` | `number` | A numeric value equal to the seconds value. | -| `ms?` | `number` | A numeric value equal to the milliseconds value. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:857 - -___ - -### setUTCMilliseconds - -▸ **setUTCMilliseconds**(`ms`): `number` - -Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `ms` | `number` | A numeric value equal to the millisecond value. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:814 - -___ - -### setUTCMinutes - -▸ **setUTCMinutes**(`min`, `sec?`, `ms?`): `number` - -Sets the minutes value in the Date object using Universal Coordinated Time (UTC). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `min` | `number` | A numeric value equal to the minutes value. | -| `sec?` | `number` | A numeric value equal to the seconds value. | -| `ms?` | `number` | A numeric value equal to the milliseconds value. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:841 - -___ - -### setUTCMonth - -▸ **setUTCMonth**(`month`, `date?`): `number` - -Sets the month value in the Date object using Universal Coordinated Time (UTC). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `month` | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. | -| `date?` | `number` | A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:879 - -___ - -### setUTCSeconds - -▸ **setUTCSeconds**(`sec`, `ms?`): `number` - -Sets the seconds value in the Date object using Universal Coordinated Time (UTC). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sec` | `number` | A numeric value equal to the seconds value. | -| `ms?` | `number` | A numeric value equal to the milliseconds value. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:827 - -___ - -### toDateString - -▸ **toDateString**(): `string` - -Returns a date as a string value. - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:753 - -___ - -### toISOString - -▸ **toISOString**(): `string` - -Returns a date as a string value in ISO format. - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:897 - -___ - -### toJSON - -▸ **toJSON**(`key?`): `string` - -Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key?` | `any` | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:899 - -___ - -### toLocaleDateString - -▸ **toLocaleDateString**(): `string` - -Returns a date as a string value appropriate to the host environment's current locale. - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:759 - -▸ **toLocaleDateString**(`locales?`, `options?`): `string` - -Converts a date to a string by using the current or specified locale. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | -| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4487 - -___ - -### toLocaleString - -▸ **toLocaleString**(): `string` - -Returns a value as a string value appropriate to the host environment's current locale. - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:757 - -▸ **toLocaleString**(`locales?`, `options?`): `string` - -Converts a date and time to a string by using the current or specified locale. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | -| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4481 - -___ - -### toLocaleTimeString - -▸ **toLocaleTimeString**(): `string` - -Returns a time as a string value appropriate to the host environment's current locale. - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:761 - -▸ **toLocaleTimeString**(`locales?`, `options?`): `string` - -Converts a time to a string by using the current or specified locale. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `locales?` | `string` \| `string`[] | A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used. | -| `options?` | [`DateTimeFormatOptions`](internal.DateTimeFormatOptions.md) | An object that contains one or more properties that specify comparison options. | - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4494 - -___ - -### toString - -▸ **toString**(): `string` - -Returns a string representation of a date. The format of the string depends on the locale. - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:751 - -___ - -### toTimeString - -▸ **toTimeString**(): `string` - -Returns a time as a string value. - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:755 - -___ - -### toUTCString - -▸ **toUTCString**(): `string` - -Returns a date converted to a string using Universal Coordinated Time (UTC). - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:895 - -___ - -### valueOf - -▸ **valueOf**(): `number` - -Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC. - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:763 diff --git a/docs/content/references/js-client/interfaces/internal.DateConstructor.md b/docs/content/references/js-client/interfaces/internal.DateConstructor.md deleted file mode 100644 index d914a797ac..0000000000 --- a/docs/content/references/js-client/interfaces/internal.DateConstructor.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: DateConstructor - -[internal](../modules/internal.md).DateConstructor - -## Callable - -### DateConstructor - -▸ **DateConstructor**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:906 - -## Properties - -### prototype - -• `Readonly` **prototype**: [`Date`](../modules/internal.md#date) - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:907 - -## Methods - -### UTC - -▸ **UTC**(`year`, `month`, `date?`, `hours?`, `minutes?`, `seconds?`, `ms?`): `number` - -Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `year` | `number` | The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year. | -| `month` | `number` | The month as a number between 0 and 11 (January to December). | -| `date?` | `number` | The date as a number between 1 and 31. | -| `hours?` | `number` | Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour. | -| `minutes?` | `number` | Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes. | -| `seconds?` | `number` | Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds. | -| `ms?` | `number` | A number from 0 to 999 that specifies the milliseconds. | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:923 - -___ - -### now - -▸ **now**(): `number` - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:924 - -___ - -### parse - -▸ **parse**(`s`): `number` - -Parses a string containing a date, and returns the number of milliseconds between that date and midnight, January 1, 1970. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `s` | `string` | A date string | - -#### Returns - -`number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:912 diff --git a/docs/content/references/js-client/interfaces/internal.DateTimeFormatOptions.md b/docs/content/references/js-client/interfaces/internal.DateTimeFormatOptions.md deleted file mode 100644 index 4db4e7c23b..0000000000 --- a/docs/content/references/js-client/interfaces/internal.DateTimeFormatOptions.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: DateTimeFormatOptions - -[internal](../modules/internal.md).DateTimeFormatOptions - -## Properties - -### calendar - -• `Optional` **calendar**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.intl.d.ts:237 - -___ - -### dateStyle - -• `Optional` **dateStyle**: ``"long"`` \| ``"short"`` \| ``"full"`` \| ``"medium"`` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.intl.d.ts:241 - -___ - -### day - -• `Optional` **day**: ``"numeric"`` \| ``"2-digit"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4418 - -___ - -### dayPeriod - -• `Optional` **dayPeriod**: ``"long"`` \| ``"short"`` \| ``"narrow"`` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.intl.d.ts:238 - -___ - -### era - -• `Optional` **era**: ``"long"`` \| ``"short"`` \| ``"narrow"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4415 - -___ - -### formatMatcher - -• `Optional` **formatMatcher**: ``"best fit"`` \| ``"basic"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4423 - -___ - -### hour - -• `Optional` **hour**: ``"numeric"`` \| ``"2-digit"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4419 - -___ - -### hour12 - -• `Optional` **hour12**: `boolean` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4424 - -___ - -### hourCycle - -• `Optional` **hourCycle**: ``"h11"`` \| ``"h12"`` \| ``"h23"`` \| ``"h24"`` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.intl.d.ts:243 - -___ - -### localeMatcher - -• `Optional` **localeMatcher**: ``"best fit"`` \| ``"lookup"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4413 - -___ - -### minute - -• `Optional` **minute**: ``"numeric"`` \| ``"2-digit"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4420 - -___ - -### month - -• `Optional` **month**: ``"long"`` \| ``"short"`` \| ``"narrow"`` \| ``"numeric"`` \| ``"2-digit"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4417 - -___ - -### numberingSystem - -• `Optional` **numberingSystem**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.intl.d.ts:239 - -___ - -### second - -• `Optional` **second**: ``"numeric"`` \| ``"2-digit"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4421 - -___ - -### timeStyle - -• `Optional` **timeStyle**: ``"long"`` \| ``"short"`` \| ``"full"`` \| ``"medium"`` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.intl.d.ts:242 - -___ - -### timeZone - -• `Optional` **timeZone**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4425 - -___ - -### timeZoneName - -• `Optional` **timeZoneName**: ``"long"`` \| ``"short"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4422 - -___ - -### weekday - -• `Optional` **weekday**: ``"long"`` \| ``"short"`` \| ``"narrow"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4414 - -___ - -### year - -• `Optional` **year**: ``"numeric"`` \| ``"2-digit"`` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:4416 diff --git a/docs/content/references/js-client/interfaces/internal.Error.md b/docs/content/references/js-client/interfaces/internal.Error.md deleted file mode 100644 index e1fb246c7b..0000000000 --- a/docs/content/references/js-client/interfaces/internal.Error.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: Error - -[internal](../modules/internal.md).Error - -## Properties - -### message - -• **message**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1023 - -___ - -### name - -• **name**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1022 - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1024 diff --git a/docs/content/references/js-client/interfaces/internal.ErrorConstructor.md b/docs/content/references/js-client/interfaces/internal.ErrorConstructor.md deleted file mode 100644 index e51b3b673f..0000000000 --- a/docs/content/references/js-client/interfaces/internal.ErrorConstructor.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: ErrorConstructor - -[internal](../modules/internal.md).ErrorConstructor - -## Callable - -### ErrorConstructor - -▸ **ErrorConstructor**(`message?`): [`Error`](../modules/internal.md#error) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message?` | `string` | - -#### Returns - -[`Error`](../modules/internal.md#error) - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1029 - -## Properties - -### prepareStackTrace - -• `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/internal.md#error), `stackTraces`: [`CallSite`](internal.CallSite.md)[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`Error`](../modules/internal.md#error) | -| `stackTraces` | [`CallSite`](internal.CallSite.md)[] | - -##### Returns - -`any` - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - -___ - -### prototype - -• `Readonly` **prototype**: [`Error`](../modules/internal.md#error) - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1030 - -___ - -### stackTraceLimit - -• **stackTraceLimit**: `number` - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | [`Function`](../modules/internal.md#function) | - -#### Returns - -`void` - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/docs/content/references/js-client/interfaces/internal.Function.md b/docs/content/references/js-client/interfaces/internal.Function.md deleted file mode 100644 index 15c50e6979..0000000000 --- a/docs/content/references/js-client/interfaces/internal.Function.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: Function - -[internal](../modules/internal.md).Function - -Creates a new function. - -## Properties - -### arguments - -• **arguments**: `any` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:304 - -___ - -### caller - -• **caller**: [`Function`](../modules/internal.md#function) - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:305 - -___ - -### length - -• `Readonly` **length**: `number` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:301 - -___ - -### name - -• `Readonly` **name**: `string` - -Returns the name of the function. Function names are read-only and can not be changed. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.core.d.ts:97 - -___ - -### prototype - -• **prototype**: `any` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:300 - -## Methods - -### [hasInstance] - -▸ **[hasInstance]**(`value`): `boolean` - -Determines whether the given value inherits from this function if this function was used -as a constructor function. - -A constructor function can control which objects are recognized as its instances by -'instanceof' by overriding this method. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value` | `any` | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:162 - -___ - -### apply - -▸ **apply**(`this`, `thisArg`, `argArray?`): `any` - -Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `this` | [`Function`](../modules/internal.md#function) | - | -| `thisArg` | `any` | The object to be used as the this object. | -| `argArray?` | `any` | A set of arguments to be passed to the function. | - -#### Returns - -`any` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:280 - -___ - -### bind - -▸ **bind**(`this`, `thisArg`, ...`argArray`): `any` - -For a given function, creates a bound function that has the same body as the original function. -The this object of the bound function is associated with the specified object, and has the specified initial parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `this` | [`Function`](../modules/internal.md#function) | - | -| `thisArg` | `any` | An object to which the this keyword can refer inside the new function. | -| `...argArray` | `any`[] | A list of arguments to be passed to the new function. | - -#### Returns - -`any` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:295 - -___ - -### call - -▸ **call**(`this`, `thisArg`, ...`argArray`): `any` - -Calls a method of an object, substituting another object for the current object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `this` | [`Function`](../modules/internal.md#function) | - | -| `thisArg` | `any` | The object to be used as the current object. | -| `...argArray` | `any`[] | A list of arguments to be passed to the method. | - -#### Returns - -`any` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:287 - -___ - -### toString - -▸ **toString**(): `string` - -Returns a string representation of a function. - -#### Returns - -`string` - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:298 diff --git a/docs/content/references/js-client/interfaces/internal.FunctionConstructor.md b/docs/content/references/js-client/interfaces/internal.FunctionConstructor.md deleted file mode 100644 index 36c39878e0..0000000000 --- a/docs/content/references/js-client/interfaces/internal.FunctionConstructor.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: FunctionConstructor - -[internal](../modules/internal.md).FunctionConstructor - -## Callable - -### FunctionConstructor - -▸ **FunctionConstructor**(...`args`): [`Function`](../modules/internal.md#function) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `string`[] | - -#### Returns - -[`Function`](../modules/internal.md#function) - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:314 - -## Properties - -### prototype - -• `Readonly` **prototype**: [`Function`](../modules/internal.md#function) - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:315 diff --git a/docs/content/references/js-client/interfaces/internal.HTTPResponse.md b/docs/content/references/js-client/interfaces/internal.HTTPResponse.md index 5e981c2645..06a14d9b3e 100644 --- a/docs/content/references/js-client/interfaces/internal.HTTPResponse.md +++ b/docs/content/references/js-client/interfaces/internal.HTTPResponse.md @@ -14,17 +14,17 @@ displayed_sidebar: jsClientSidebar #### Defined in -[packages/medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L13) +[medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L13) ___ ### headers -• **headers**: [`Record`](../modules/internal.md#record)<`string`, `string`\> & { `set-cookie?`: `string`[] } +• **headers**: `Record`<`string`, `string`\> & { `set-cookie?`: `string`[] } #### Defined in -[packages/medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L10) +[medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L10) ___ @@ -34,7 +34,7 @@ ___ #### Defined in -[packages/medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L14) +[medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L14) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[packages/medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L8) +[medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L8) ___ @@ -54,4 +54,4 @@ ___ #### Defined in -[packages/medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/typings.ts#L9) +[medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L9) diff --git a/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md b/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md index 0d7d9111c7..d870ed1e0f 100644 --- a/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md +++ b/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:98 +medusa-js/node_modules/axios/index.d.ts:98 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:99 +medusa-js/node_modules/axios/index.d.ts:99 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:100 +medusa-js/node_modules/axios/index.d.ts:100 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:101 +medusa-js/node_modules/axios/index.d.ts:101 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:107 +medusa-js/node_modules/axios/index.d.ts:107 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:105 +medusa-js/node_modules/axios/index.d.ts:105 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:104 +medusa-js/node_modules/axios/index.d.ts:104 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:102 +medusa-js/node_modules/axios/index.d.ts:102 ___ @@ -94,7 +94,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:106 +medusa-js/node_modules/axios/index.d.ts:106 ___ @@ -104,7 +104,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:103 +medusa-js/node_modules/axios/index.d.ts:103 ___ @@ -114,4 +114,4 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:108 +medusa-js/node_modules/axios/index.d.ts:108 diff --git a/docs/content/references/js-client/interfaces/internal.Iterable.md b/docs/content/references/js-client/interfaces/internal.Iterable.md deleted file mode 100644 index 1c308f9a19..0000000000 --- a/docs/content/references/js-client/interfaces/internal.Iterable.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: Iterable - -[internal](../modules/internal.md).Iterable - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Methods - -### [iterator] - -▸ **[iterator]**(): [`Iterator`](internal.Iterator.md)<`T`, `any`, `undefined`\> - -#### Returns - -[`Iterator`](internal.Iterator.md)<`T`, `any`, `undefined`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:51 diff --git a/docs/content/references/js-client/interfaces/internal.Iterator.md b/docs/content/references/js-client/interfaces/internal.Iterator.md deleted file mode 100644 index 533ec361c1..0000000000 --- a/docs/content/references/js-client/interfaces/internal.Iterator.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: Iterator - -[internal](../modules/internal.md).Iterator - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `T` | -| `TReturn` | `any` | -| `TNext` | `undefined` | - -## Methods - -### next - -▸ **next**(...`args`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | [] \| [`TNext`] | - -#### Returns - -[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 - -___ - -### return - -▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `value?` | `TReturn` | - -#### Returns - -[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:46 - -___ - -### throw - -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `e?` | `any` | - -#### Returns - -[`IteratorResult`](../modules/internal.md#iteratorresult)<`T`, `TReturn`\> - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:47 diff --git a/docs/content/references/js-client/interfaces/internal.IteratorReturnResult.md b/docs/content/references/js-client/interfaces/internal.IteratorReturnResult.md deleted file mode 100644 index 11c3891a0f..0000000000 --- a/docs/content/references/js-client/interfaces/internal.IteratorReturnResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: IteratorReturnResult - -[internal](../modules/internal.md).IteratorReturnResult - -## Type parameters - -| Name | -| :------ | -| `TReturn` | - -## Properties - -### done - -• **done**: ``true`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:37 - -___ - -### value - -• **value**: `TReturn` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:38 diff --git a/docs/content/references/js-client/interfaces/internal.IteratorYieldResult.md b/docs/content/references/js-client/interfaces/internal.IteratorYieldResult.md deleted file mode 100644 index 27e228d12f..0000000000 --- a/docs/content/references/js-client/interfaces/internal.IteratorYieldResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: IteratorYieldResult - -[internal](../modules/internal.md).IteratorYieldResult - -## Type parameters - -| Name | -| :------ | -| `TYield` | - -## Properties - -### done - -• `Optional` **done**: ``false`` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:32 - -___ - -### value - -• **value**: `TYield` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:33 diff --git a/docs/content/references/js-client/interfaces/internal.Promise.md b/docs/content/references/js-client/interfaces/internal.Promise.md deleted file mode 100644 index 9baca2f495..0000000000 --- a/docs/content/references/js-client/interfaces/internal.Promise.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: Promise - -[internal](../modules/internal.md).Promise - -Represents the completion of an asynchronous operation - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### [toStringTag] - -• `Readonly` **[toStringTag]**: `string` - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:174 - -## Methods - -### catch - -▸ **catch**<`TResult`\>(`onrejected?`): [`Promise`](../modules/internal.md#promise)<`T` \| `TResult`\> - -Attaches a callback for only the rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<`T` \| `TResult`\> - -A Promise for the completion of the callback. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1509 - -___ - -### finally - -▸ **finally**(`onfinally?`): [`Promise`](../modules/internal.md#promise)<`T`\> - -Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The -resolved value cannot be modified from the callback. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfinally?` | ``null`` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<`T`\> - -A Promise for the completion of the callback. - -#### Defined in - -node_modules/typescript/lib/lib.es2018.promise.d.ts:31 - -___ - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1502 diff --git a/docs/content/references/js-client/interfaces/internal.PromiseConstructor.md b/docs/content/references/js-client/interfaces/internal.PromiseConstructor.md deleted file mode 100644 index ec58e4ae02..0000000000 --- a/docs/content/references/js-client/interfaces/internal.PromiseConstructor.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: PromiseConstructor - -[internal](../modules/internal.md).PromiseConstructor - -## Properties - -### [species] - -• `Readonly` **[species]**: [`PromiseConstructor`](internal.PromiseConstructor.md) - -#### Defined in - -node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:178 - -___ - -### prototype - -• `Readonly` **prototype**: [`Promise`](../modules/internal.md#promise)<`any`\> - -A reference to the prototype. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.promise.d.ts:25 - -## Methods - -### all - -▸ **all**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>[]\> - -Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An iterable of Promises. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>[]\> - -A new Promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:226 - -▸ **all**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: Awaited }\> - -Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends readonly `unknown`[] \| [] | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `values` | `T` | An array of Promises. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: Awaited }\> - -A new Promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.promise.d.ts:41 - -___ - -### allSettled - -▸ **allSettled**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: PromiseSettledResult\> }\> - -Creates a Promise that is resolved with an array of results when all -of the provided Promises resolve or reject. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends readonly `unknown`[] \| [] | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `values` | `T` | An array of Promises. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<{ -readonly [P in string \| number \| symbol]: PromiseSettledResult\> }\> - -A new Promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2020.promise.d.ts:40 - -▸ **allSettled**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`PromiseSettledResult`](../modules/internal.md#promisesettledresult)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\>[]\> - -Creates a Promise that is resolved with an array of results when all -of the provided Promises resolve or reject. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An array of Promises. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<[`PromiseSettledResult`](../modules/internal.md#promisesettledresult)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\>[]\> - -A new Promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2020.promise.d.ts:48 - -___ - -### race - -▸ **race**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\> - -Creates a Promise that is resolved or rejected when any of the provided Promises are resolved -or rejected. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `values` | [`Iterable`](internal.Iterable.md)<`T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\>\> | An iterable of Promises. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`\>\> - -A new Promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:234 - -▸ **race**<`T`\>(`values`): [`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`[`number`]\>\> - -Creates a Promise that is resolved or rejected when any of the provided Promises are resolved -or rejected. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends readonly `unknown`[] \| [] | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `values` | `T` | An array of Promises. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<[`Awaited`](../modules/internal.md#awaited)<`T`[`number`]\>\> - -A new Promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.promise.d.ts:52 - -___ - -### reject - -▸ **reject**<`T`\>(`reason?`): [`Promise`](../modules/internal.md#promise)<`T`\> - -Creates a new rejected promise for the provided reason. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `reason?` | `any` | The reason the promise was rejected. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<`T`\> - -A new rejected Promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.promise.d.ts:62 - -___ - -### resolve - -▸ **resolve**(): [`Promise`](../modules/internal.md#promise)<`void`\> - -Creates a new resolved promise. - -#### Returns - -[`Promise`](../modules/internal.md#promise)<`void`\> - -A resolved promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.promise.d.ts:68 - -▸ **resolve**<`T`\>(`value`): [`Promise`](../modules/internal.md#promise)<`T`\> - -Creates a new resolved promise for the provided value. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `value` | `T` \| [`PromiseLike`](internal.PromiseLike.md)<`T`\> | A promise. | - -#### Returns - -[`Promise`](../modules/internal.md#promise)<`T`\> - -A promise whose internal state matches the provided promise. - -#### Defined in - -node_modules/typescript/lib/lib.es2015.promise.d.ts:75 diff --git a/docs/content/references/js-client/interfaces/internal.PromiseFulfilledResult.md b/docs/content/references/js-client/interfaces/internal.PromiseFulfilledResult.md deleted file mode 100644 index edabd243f3..0000000000 --- a/docs/content/references/js-client/interfaces/internal.PromiseFulfilledResult.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: PromiseFulfilledResult - -[internal](../modules/internal.md).PromiseFulfilledResult - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### status - -• **status**: ``"fulfilled"`` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.promise.d.ts:22 - -___ - -### value - -• **value**: `T` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.promise.d.ts:23 diff --git a/docs/content/references/js-client/interfaces/internal.PromiseLike.md b/docs/content/references/js-client/interfaces/internal.PromiseLike.md deleted file mode 100644 index 9dc3e39518..0000000000 --- a/docs/content/references/js-client/interfaces/internal.PromiseLike.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: PromiseLike - -[internal](../modules/internal.md).PromiseLike - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Methods - -### then - -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](internal.PromiseLike.md)<`TResult1` \| `TResult2`\> - -Attaches callbacks for the resolution and/or rejection of the Promise. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult1` | `T` | -| `TResult2` | `never` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | -| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | - -#### Returns - -[`PromiseLike`](internal.PromiseLike.md)<`TResult1` \| `TResult2`\> - -A Promise for the completion of which ever callback is executed. - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1489 diff --git a/docs/content/references/js-client/interfaces/internal.PromiseRejectedResult.md b/docs/content/references/js-client/interfaces/internal.PromiseRejectedResult.md deleted file mode 100644 index e7a4544c6c..0000000000 --- a/docs/content/references/js-client/interfaces/internal.PromiseRejectedResult.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: PromiseRejectedResult - -[internal](../modules/internal.md).PromiseRejectedResult - -## Properties - -### reason - -• **reason**: `any` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.promise.d.ts:28 - -___ - -### status - -• **status**: ``"rejected"`` - -#### Defined in - -node_modules/typescript/lib/lib.es2020.promise.d.ts:27 diff --git a/docs/content/references/js-client/interfaces/internal.RequestOptions.md b/docs/content/references/js-client/interfaces/internal.RequestOptions.md index da16462200..4246e3083f 100644 --- a/docs/content/references/js-client/interfaces/internal.RequestOptions.md +++ b/docs/content/references/js-client/interfaces/internal.RequestOptions.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -[packages/medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L18) +[medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L18) ___ @@ -24,4 +24,4 @@ ___ #### Defined in -[packages/medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/request.ts#L17) +[medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L17) diff --git a/docs/content/references/js-client/interfaces/internal.RetryConfig.md b/docs/content/references/js-client/interfaces/internal.RetryConfig.md index c7195f2ae4..261c917c6c 100644 --- a/docs/content/references/js-client/interfaces/internal.RetryConfig.md +++ b/docs/content/references/js-client/interfaces/internal.RetryConfig.md @@ -18,7 +18,7 @@ Backoff Type; 'linear', 'static' or 'exponential'. #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47 ___ @@ -30,7 +30,7 @@ Whether to check for 'Retry-After' header in response and use value as delay. De #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51 ___ @@ -42,7 +42,7 @@ The number of retries already attempted. #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13 ___ @@ -50,12 +50,12 @@ ___ • `Optional` **httpMethodsToRetry**: `string`[] -The HTTP Methods that will be automatically retried. +The HTTP Methods that will be automatically retried. Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE'] #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26 ___ @@ -67,7 +67,7 @@ The instance of the axios object to which the interceptor is attached. #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21 ___ @@ -79,7 +79,7 @@ Max permitted Retry-After value (in ms) - rejects if greater. Defaults to 5 mins #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55 ___ @@ -91,7 +91,7 @@ Ceiling for calculated delay (in ms) - delay will not exceed this value. #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59 ___ @@ -103,7 +103,33 @@ When there is no response, the number of retries to attempt. Defaults to 2. #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43 + +___ + +### onRetryAttempt + +• `Optional` **onRetryAttempt**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `void` + +#### Type declaration + +▸ (`err`): `void` + +Function to invoke when a retry attempt is made. + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> | + +##### Returns + +`void` + +#### Defined in + +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35 ___ @@ -115,7 +141,7 @@ The number of times to retry the request. Defaults to 3. #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9 ___ @@ -127,7 +153,33 @@ The amount of time to initially delay the retry. Defaults to 100. #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17 + +___ + +### shouldRetry + +• `Optional` **shouldRetry**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `boolean` + +#### Type declaration + +▸ (`err`): `boolean` + +Function to invoke which determines if you should retry + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> | + +##### Returns + +`boolean` + +#### Defined in + +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39 ___ @@ -135,53 +187,9 @@ ___ • `Optional` **statusCodesToRetry**: `number`[][] -The HTTP response status codes that will automatically be retried. +The HTTP response status codes that will automatically be retried. Defaults to: [[100, 199], [429, 429], [500, 599]] #### Defined in -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31 - -## Methods - -### onRetryAttempt - -▸ `Optional` **onRetryAttempt**(`err`): `void` - -Function to invoke when a retry attempt is made. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> | - -#### Returns - -`void` - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35 - -___ - -### shouldRetry - -▸ `Optional` **shouldRetry**(`err`): `boolean` - -Function to invoke which determines if you should retry - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> | - -#### Returns - -`boolean` - -#### Defined in - -packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39 +medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31 diff --git a/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md b/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md index 7fbb2d8253..2907abad62 100644 --- a/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md +++ b/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:59 +medusa-js/node_modules/axios/index.d.ts:59 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:58 +medusa-js/node_modules/axios/index.d.ts:58 ___ @@ -34,4 +34,4 @@ ___ #### Defined in -packages/medusa-js/node_modules/axios/index.d.ts:57 +medusa-js/node_modules/axios/index.d.ts:57 diff --git a/docs/content/references/js-client/modules/internal-1.md b/docs/content/references/js-client/modules/internal-1.md new file mode 100644 index 0000000000..bd10fb9e18 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-1.md @@ -0,0 +1,26 @@ +# Namespace: internal + +## Enumerations + +- [UserRoles](../enums/internal-1.UserRoles.md) + +## Classes + +- [AdminPostAuthReq](../classes/internal-1.AdminPostAuthReq.md) +- [User](../classes/internal-1.User.md) + +## Type Aliases + +### AdminAuthRes + +Ƭ **AdminAuthRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | + +#### Defined in + +medusa/dist/api/routes/admin/auth/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-10.md b/docs/content/references/js-client/modules/internal-10.md new file mode 100644 index 0000000000..adb9caec2c --- /dev/null +++ b/docs/content/references/js-client/modules/internal-10.md @@ -0,0 +1,34 @@ +# Namespace: internal + +## Classes + +- [AdminGetNotesParams](../classes/internal-10.AdminGetNotesParams.md) +- [AdminPostNotesNoteReq](../classes/internal-10.AdminPostNotesNoteReq.md) +- [AdminPostNotesReq](../classes/internal-10.AdminPostNotesReq.md) +- [Note](../classes/internal-10.Note.md) + +## Type Aliases + +### AdminNotesListRes + +Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-10.Note.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/notes/index.d.ts:10 + +___ + +### AdminNotesRes + +Ƭ **AdminNotesRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `note` | [`Note`](../classes/internal-10.Note.md) | + +#### Defined in + +medusa/dist/api/routes/admin/notes/index.d.ts:6 diff --git a/docs/content/references/js-client/modules/internal-11.md b/docs/content/references/js-client/modules/internal-11.md new file mode 100644 index 0000000000..5e1e85393a --- /dev/null +++ b/docs/content/references/js-client/modules/internal-11.md @@ -0,0 +1,40 @@ +# Namespace: internal + +## Classes + +- [AdminGetNotificationsParams](../classes/internal-11.AdminGetNotificationsParams.md) +- [AdminPostNotificationsNotificationResendReq](../classes/internal-11.AdminPostNotificationsNotificationResendReq.md) +- [Notification](../classes/internal-11.Notification.md) +- [NotificationProvider](../classes/internal-11.NotificationProvider.md) + +## Type Aliases + +### AdminNotificationsListRes + +Ƭ **AdminNotificationsListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `notifications` | [`Notification`](../classes/internal-11.Notification.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/notifications/index.d.ts:8 + +___ + +### AdminNotificationsRes + +Ƭ **AdminNotificationsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `notification` | [`Notification`](../classes/internal-11.Notification.md) | + +#### Defined in + +medusa/dist/api/routes/admin/notifications/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-12.md b/docs/content/references/js-client/modules/internal-12.md new file mode 100644 index 0000000000..63606088d1 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-12.md @@ -0,0 +1,62 @@ +# Namespace: internal + +## Classes + +- [AdditionalItem](../classes/internal-12.AdditionalItem.md) +- [AdditionalItem](../classes/internal-12.AdditionalItem-1.md) +- [AdminGetOrdersParams](../classes/internal-12.AdminGetOrdersParams.md) +- [AdminListOrdersSelector](../classes/internal-12.AdminListOrdersSelector.md) +- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) +- [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md) +- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) +- [AdminPostOrdersOrderClaimsReq](../classes/internal-12.AdminPostOrdersOrderClaimsReq.md) +- [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md) +- [AdminPostOrdersOrderRefundsReq](../classes/internal-12.AdminPostOrdersOrderRefundsReq.md) +- [AdminPostOrdersOrderReq](../classes/internal-12.AdminPostOrdersOrderReq.md) +- [AdminPostOrdersOrderReturnsReq](../classes/internal-12.AdminPostOrdersOrderReturnsReq.md) +- [AdminPostOrdersOrderShipmentReq](../classes/internal-12.AdminPostOrdersOrderShipmentReq.md) +- [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md) +- [AdminPostOrdersOrderSwapsReq](../classes/internal-12.AdminPostOrdersOrderSwapsReq.md) +- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) +- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) +- [CustomShippingOption](../classes/internal-12.CustomShippingOption.md) +- [Image](../classes/internal-12.Image.md) +- [Item](../classes/internal-12.Item.md) +- [Item](../classes/internal-12.Item-1.md) +- [Item](../classes/internal-12.Item-2.md) +- [OrdersReturnItem](../classes/internal-12.OrdersReturnItem.md) +- [PaymentMethod](../classes/internal-12.PaymentMethod.md) +- [ReturnItem](../classes/internal-12.ReturnItem.md) +- [ReturnShipping](../classes/internal-12.ReturnShipping.md) +- [ReturnShipping](../classes/internal-12.ReturnShipping-1.md) +- [ReturnShipping](../classes/internal-12.ReturnShipping-2.md) +- [ShippingMethod](../classes/internal-12.ShippingMethod.md) +- [ShippingMethod](../classes/internal-12.ShippingMethod-1.md) +- [ShippingMethod](../classes/internal-12.ShippingMethod-2.md) +- [Tag](../classes/internal-12.Tag.md) + +## Type Aliases + +### AdminOrdersListRes + +Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/orders/index.d.ts:11 + +___ + +### AdminOrdersRes + +Ƭ **AdminOrdersRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal.Order.md) | + +#### Defined in + +medusa/dist/api/routes/admin/orders/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md b/docs/content/references/js-client/modules/internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md new file mode 100644 index 0000000000..ae984dbf47 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md @@ -0,0 +1,83 @@ +# Namespace: "/Users/shahednasser/medusa/packages/medusa/dist/types/global" + +[internal](internal-13.md)."/Users/shahednasser/medusa/packages/medusa/dist/types/global" + +## Type Aliases + +### ClassConstructor + +Ƭ **ClassConstructor**<`T`\>: `Object` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +medusa/dist/types/global.d.ts:26 + +___ + +### ConfigModule + +Ƭ **ConfigModule**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `featureFlags` | `Record`<`string`, `boolean` \| `string`\> | +| `plugins` | ({ `options`: `Record`<`string`, `unknown`\> ; `resolve`: `string` } \| `string`)[] | +| `projectConfig` | { `admin_cors?`: `string` ; `cookie_secret?`: `string` ; `database_database?`: `string` ; `database_extra?`: `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } ; `database_logging`: `LoggerOptions` ; `database_type`: `string` ; `database_url?`: `string` ; `jwt_secret?`: `string` ; `redis_url?`: `string` ; `store_cors?`: `string` } | +| `projectConfig.admin_cors?` | `string` | +| `projectConfig.cookie_secret?` | `string` | +| `projectConfig.database_database?` | `string` | +| `projectConfig.database_extra?` | `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } | +| `projectConfig.database_logging` | `LoggerOptions` | +| `projectConfig.database_type` | `string` | +| `projectConfig.database_url?` | `string` | +| `projectConfig.jwt_secret?` | `string` | +| `projectConfig.redis_url?` | `string` | +| `projectConfig.store_cors?` | `string` | + +#### Defined in + +medusa/dist/types/global.d.ts:37 + +___ + +### ExtendedRequest + +Ƭ **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` } + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Defined in + +medusa/dist/types/global.d.ts:23 + +___ + +### Logger + +Ƭ **Logger**: `_Logger` & { `info`: (`msg`: `string`) => `void` ; `progress`: (`activityId`: `string`, `msg`: `string`) => `void` ; `warn`: (`msg`: `string`) => `void` } + +#### Defined in + +medusa/dist/types/global.d.ts:32 + +___ + +### MedusaContainer + +Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md#medusacontainer) } + +#### Defined in + +medusa/dist/types/global.d.ts:29 diff --git a/docs/content/references/js-client/modules/internal-13.md b/docs/content/references/js-client/modules/internal-13.md new file mode 100644 index 0000000000..2a5556a2c9 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-13.md @@ -0,0 +1,73 @@ +# Namespace: internal + +## Namespaces + +- ["/Users/shahednasser/medusa/packages/medusa/dist/types/global"](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) + +## Classes + +- [AdminDeletePriceListPricesPricesReq](../classes/internal-13.AdminDeletePriceListPricesPricesReq.md) +- [AdminGetPriceListPaginationParams](../classes/internal-13.AdminGetPriceListPaginationParams.md) +- [AdminGetPriceListsPriceListProductsParams](../classes/internal-13.AdminGetPriceListsPriceListProductsParams.md) +- [AdminPostPriceListPricesPricesReq](../classes/internal-13.AdminPostPriceListPricesPricesReq.md) +- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md) +- [AdminPostPriceListsPriceListReq](../classes/internal-13.AdminPostPriceListsPriceListReq.md) +- [AdminPriceListPricesCreateReq](../classes/internal-13.AdminPriceListPricesCreateReq.md) +- [AdminPriceListPricesUpdateReq](../classes/internal-13.AdminPriceListPricesUpdateReq.md) +- [CustomerGroup](../classes/internal-13.CustomerGroup.md) +- [CustomerGroup](../classes/internal-13.CustomerGroup-1.md) +- [FilterablePriceListProps](../classes/internal-13.FilterablePriceListProps.md) + +## Type Aliases + +### AdminPriceListDeleteBatchRes + +Ƭ **AdminPriceListDeleteBatchRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `ids` | `string`[] | +| `object` | `string` | + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/index.d.ts:12 + +___ + +### AdminPriceListRes + +Ƭ **AdminPriceListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `price_list` | [`PriceList`](../classes/internal.PriceList.md) | + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/index.d.ts:9 + +___ + +### AdminPriceListsListRes + +Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/index.d.ts:20 + +## Variables + +### AdminGetPriceListsPriceListProductsParams\_base + +• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) + +#### Defined in + +medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:54 diff --git a/docs/content/references/js-client/modules/internal-14.md b/docs/content/references/js-client/modules/internal-14.md new file mode 100644 index 0000000000..6d448a0ce2 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-14.md @@ -0,0 +1,16 @@ +# Namespace: internal + +## Classes + +- [AdminGetProductTagsPaginationParams](../classes/internal-14.AdminGetProductTagsPaginationParams.md) +- [AdminGetProductTagsParams](../classes/internal-14.AdminGetProductTagsParams.md) + +## Type Aliases + +### AdminProductTagsListRes + +Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/product-tags/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-15.md b/docs/content/references/js-client/modules/internal-15.md new file mode 100644 index 0000000000..0b45f572aa --- /dev/null +++ b/docs/content/references/js-client/modules/internal-15.md @@ -0,0 +1,16 @@ +# Namespace: internal + +## Classes + +- [AdminGetProductTypesPaginationParams](../classes/internal-15.AdminGetProductTypesPaginationParams.md) +- [AdminGetProductTypesParams](../classes/internal-15.AdminGetProductTypesParams.md) + +## Type Aliases + +### AdminProductTypesListRes + +Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/product-types/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-16.md b/docs/content/references/js-client/modules/internal-16.md new file mode 100644 index 0000000000..bc4c8b87fc --- /dev/null +++ b/docs/content/references/js-client/modules/internal-16.md @@ -0,0 +1,211 @@ +# Namespace: internal + +## Classes + +- [AdminGetProductsParams](../classes/internal-16.AdminGetProductsParams.md) +- [AdminPostProductsProductMetadataReq](../classes/internal-16.AdminPostProductsProductMetadataReq.md) +- [AdminPostProductsProductOptionsOption](../classes/internal-16.AdminPostProductsProductOptionsOption.md) +- [AdminPostProductsProductOptionsReq](../classes/internal-16.AdminPostProductsProductOptionsReq.md) +- [AdminPostProductsProductReq](../classes/internal-16.AdminPostProductsProductReq.md) +- [AdminPostProductsProductVariantsReq](../classes/internal-16.AdminPostProductsProductVariantsReq.md) +- [AdminPostProductsProductVariantsVariantReq](../classes/internal-16.AdminPostProductsProductVariantsVariantReq.md) +- [AdminPostProductsReq](../classes/internal-16.AdminPostProductsReq.md) +- [FilterableProductProps](../classes/internal-16.FilterableProductProps.md) +- [ProductOptionReq](../classes/internal-16.ProductOptionReq.md) +- [ProductSalesChannelReq](../classes/internal-16.ProductSalesChannelReq.md) +- [ProductTagReq](../classes/internal-16.ProductTagReq.md) +- [ProductTypeReq](../classes/internal-16.ProductTypeReq.md) +- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq.md) +- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-1.md) +- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-2.md) +- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-3.md) +- [ProductVariantPricesCreateReq](../classes/internal-16.ProductVariantPricesCreateReq.md) +- [ProductVariantPricesUpdateReq](../classes/internal-16.ProductVariantPricesUpdateReq.md) +- [ProductVariantReq](../classes/internal-16.ProductVariantReq.md) +- [ProductVariantReq](../classes/internal-16.ProductVariantReq-1.md) + +## Type Aliases + +### AdminProductsDeleteOptionRes + +Ƭ **AdminProductsDeleteOptionRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `object` | ``"option"`` | +| `option_id` | `string` | +| `product` | [`Product`](../classes/internal.Product.md) | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:13 + +___ + +### AdminProductsDeleteRes + +Ƭ **AdminProductsDeleteRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `id` | `string` | +| `object` | ``"product"`` | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:25 + +___ + +### AdminProductsDeleteVariantRes + +Ƭ **AdminProductsDeleteVariantRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `object` | ``"product-variant"`` | +| `product` | [`Product`](../classes/internal.Product.md) | +| `variant_id` | `string` | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:19 + +___ + +### AdminProductsListRes + +Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-16.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] } + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:30 + +___ + +### AdminProductsListTagsRes + +Ƭ **AdminProductsListTagsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:36 + +___ + +### AdminProductsListTypesRes + +Ƭ **AdminProductsListTypesRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `types` | [`ProductType`](../classes/internal.ProductType.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:33 + +___ + +### AdminProductsRes + +Ƭ **AdminProductsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `product` | [`Product`](../classes/internal.Product.md) | + +#### Defined in + +medusa/dist/api/routes/admin/products/index.d.ts:39 + +___ + +### PricedProduct + +Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-16.md#pricedvariant)[] } + +#### Defined in + +medusa/dist/types/pricing.d.ts:28 + +___ + +### PricedVariant + +Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-16.md#productvariantpricing) + +#### Defined in + +medusa/dist/types/pricing.d.ts:27 + +___ + +### ProductVariantPricing + +Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-16.md#taxedpricing) + +#### Defined in + +medusa/dist/types/pricing.d.ts:4 + +___ + +### TaxServiceRate + +Ƭ **TaxServiceRate**: `Object` + +The tax rate object as configured in Medusa. These may have an unspecified +numerical rate as they may be used for lookup purposes in the tax provider +plugin. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` \| ``null`` | +| `name` | `string` | +| `rate?` | `number` \| ``null`` | + +#### Defined in + +medusa/dist/types/tax-service.d.ts:6 + +___ + +### TaxedPricing + +Ƭ **TaxedPricing**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `calculated_price_incl_tax` | `number` \| ``null`` | +| `calculated_tax` | `number` \| ``null`` | +| `original_price_incl_tax` | `number` \| ``null`` | +| `original_tax` | `number` \| ``null`` | +| `tax_rates` | [`TaxServiceRate`](internal-16.md#taxservicerate)[] \| ``null`` | + +#### Defined in + +medusa/dist/types/pricing.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-17.md b/docs/content/references/js-client/modules/internal-17.md new file mode 100644 index 0000000000..5d4ae64605 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-17.md @@ -0,0 +1,24 @@ +# Namespace: internal + +## Classes + +- [AdminGetRegionsPaginationParams](../classes/internal-17.AdminGetRegionsPaginationParams.md) +- [AdminGetRegionsParams](../classes/internal-17.AdminGetRegionsParams.md) +- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md) +- [AdminPostRegionsRegionCountriesReq](../classes/internal-17.AdminPostRegionsRegionCountriesReq.md) +- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md) +- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md) +- [AdminPostRegionsRegionReq](../classes/internal-17.AdminPostRegionsRegionReq.md) +- [AdminPostRegionsReq](../classes/internal-17.AdminPostRegionsReq.md) +- [AdminRegionsRes](../classes/internal-17.AdminRegionsRes.md) +- [FulfillmentOption](../classes/internal-17.FulfillmentOption.md) + +## Type Aliases + +### AdminRegionsListRes + +Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/regions/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-18.md b/docs/content/references/js-client/modules/internal-18.md new file mode 100644 index 0000000000..be5f59251e --- /dev/null +++ b/docs/content/references/js-client/modules/internal-18.md @@ -0,0 +1,38 @@ +# Namespace: internal + +## Classes + +- [AdminPostReturnReasonsReasonReq](../classes/internal-18.AdminPostReturnReasonsReasonReq.md) +- [AdminPostReturnReasonsReq](../classes/internal-18.AdminPostReturnReasonsReq.md) + +## Type Aliases + +### AdminReturnReasonsListRes + +Ƭ **AdminReturnReasonsListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/index.d.ts:10 + +___ + +### AdminReturnReasonsRes + +Ƭ **AdminReturnReasonsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | + +#### Defined in + +medusa/dist/api/routes/admin/return-reasons/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-19.md b/docs/content/references/js-client/modules/internal-19.md new file mode 100644 index 0000000000..fe202df01d --- /dev/null +++ b/docs/content/references/js-client/modules/internal-19.md @@ -0,0 +1,49 @@ +# Namespace: internal + +## Classes + +- [AdminGetReturnsParams](../classes/internal-19.AdminGetReturnsParams.md) +- [AdminPostReturnsReturnReceiveReq](../classes/internal-19.AdminPostReturnsReturnReceiveReq.md) +- [Item](../classes/internal-19.Item.md) + +## Type Aliases + +### AdminReturnsCancelRes + +Ƭ **AdminReturnsCancelRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal.Order.md) | + +#### Defined in + +medusa/dist/api/routes/admin/returns/index.d.ts:6 + +___ + +### AdminReturnsListRes + +Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/returns/index.d.ts:9 + +___ + +### AdminReturnsRes + +Ƭ **AdminReturnsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return` | [`Return`](../classes/internal.Return.md) | + +#### Defined in + +medusa/dist/api/routes/admin/returns/index.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-2.md b/docs/content/references/js-client/modules/internal-2.md new file mode 100644 index 0000000000..3ef56408f1 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-2.md @@ -0,0 +1,96 @@ +# Namespace: internal + +## Enumerations + +- [BatchJobStatus](../enums/internal-2.BatchJobStatus.md) + +## Classes + +- [AdminGetBatchPaginationParams](../classes/internal-2.AdminGetBatchPaginationParams.md) +- [AdminGetBatchParams](../classes/internal-2.AdminGetBatchParams.md) +- [AdminPostBatchesReq](../classes/internal-2.AdminPostBatchesReq.md) +- [BatchJob](../classes/internal-2.BatchJob.md) +- [DateComparisonOperator](../classes/internal-2.DateComparisonOperator.md) + +## Type Aliases + +### AdminBatchJobListRes + +Ƭ **AdminBatchJobListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../classes/internal-2.BatchJob.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/batch/index.d.ts:9 + +___ + +### AdminBatchJobRes + +Ƭ **AdminBatchJobRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `batch_job` | [`BatchJob`](../classes/internal-2.BatchJob.md) | + +#### Defined in + +medusa/dist/api/routes/admin/batch/index.d.ts:5 + +___ + +### BatchJobResultError + +Ƭ **BatchJobResultError**: `Object` + +#### Index signature + +▪ [key: `string`]: `unknown` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` \| `number` | +| `message` | `string` | + +#### Defined in + +medusa/dist/types/batch-job.d.ts:18 + +___ + +### BatchJobResultStatDescriptor + +Ƭ **BatchJobResultStatDescriptor**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `message` | `string` | +| `name` | `string` | + +#### Defined in + +medusa/dist/types/batch-job.d.ts:23 + +___ + +### PaginatedResponse + +Ƭ **PaginatedResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `count` | `number` | +| `limit` | `number` | +| `offset` | `number` | + +#### Defined in + +medusa/dist/types/common.d.ts:59 diff --git a/docs/content/references/js-client/modules/internal-20.md b/docs/content/references/js-client/modules/internal-20.md new file mode 100644 index 0000000000..20494718e8 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-20.md @@ -0,0 +1,46 @@ +# Namespace: internal + +## Classes + +- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md) +- [AdminGetSalesChannelsParams](../classes/internal-20.AdminGetSalesChannelsParams.md) +- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md) +- [AdminPostSalesChannelsReq](../classes/internal-20.AdminPostSalesChannelsReq.md) +- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md) +- [ProductBatchSalesChannel](../classes/internal-20.ProductBatchSalesChannel.md) + +## Type Aliases + +### AdminSalesChannelsListRes + +Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/index.d.ts:10 + +___ + +### AdminSalesChannelsRes + +Ƭ **AdminSalesChannelsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) | + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/index.d.ts:6 + +## Variables + +### AdminGetSalesChannelsParams\_base + +• `Const` **AdminGetSalesChannelsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md) + +#### Defined in + +medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:47 diff --git a/docs/content/references/js-client/modules/internal-21.md b/docs/content/references/js-client/modules/internal-21.md new file mode 100644 index 0000000000..5f259ae622 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-21.md @@ -0,0 +1,35 @@ +# Namespace: internal + +## Classes + +- [AdminGetShippingOptionsParams](../classes/internal-21.AdminGetShippingOptionsParams.md) +- [AdminPostShippingOptionsOptionReq](../classes/internal-21.AdminPostShippingOptionsOptionReq.md) +- [AdminPostShippingOptionsReq](../classes/internal-21.AdminPostShippingOptionsReq.md) +- [OptionRequirement](../classes/internal-21.OptionRequirement.md) +- [OptionRequirement](../classes/internal-21.OptionRequirement-1.md) + +## Type Aliases + +### AdminShippingOptionsListRes + +Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/index.d.ts:7 + +___ + +### AdminShippingOptionsRes + +Ƭ **AdminShippingOptionsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) | + +#### Defined in + +medusa/dist/api/routes/admin/shipping-options/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-22.md b/docs/content/references/js-client/modules/internal-22.md new file mode 100644 index 0000000000..53e1b6a6a6 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-22.md @@ -0,0 +1,38 @@ +# Namespace: internal + +## Classes + +- [AdminPostShippingProfilesProfileReq](../classes/internal-22.AdminPostShippingProfilesProfileReq.md) +- [AdminPostShippingProfilesReq](../classes/internal-22.AdminPostShippingProfilesReq.md) + +## Type Aliases + +### AdminShippingProfilesListRes + +Ƭ **AdminShippingProfilesListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12 + +___ + +### AdminShippingProfilesRes + +Ƭ **AdminShippingProfilesRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) | + +#### Defined in + +medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-23.md b/docs/content/references/js-client/modules/internal-23.md new file mode 100644 index 0000000000..138a586dd0 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-23.md @@ -0,0 +1,54 @@ +# Namespace: internal + +## Classes + +- [AdminPostStoreReq](../classes/internal-23.AdminPostStoreReq.md) +- [Store](../classes/internal-23.Store.md) + +## Type Aliases + +### AdminPaymentProvidersList + +Ƭ **AdminPaymentProvidersList**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/store/index.d.ts:10 + +___ + +### AdminStoresRes + +Ƭ **AdminStoresRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `store` | [`Store`](../classes/internal-23.Store.md) | + +#### Defined in + +medusa/dist/api/routes/admin/store/index.d.ts:4 + +___ + +### AdminTaxProvidersList + +Ƭ **AdminTaxProvidersList**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/store/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-24.md b/docs/content/references/js-client/modules/internal-24.md new file mode 100644 index 0000000000..0e24b097ec --- /dev/null +++ b/docs/content/references/js-client/modules/internal-24.md @@ -0,0 +1,31 @@ +# Namespace: internal + +## Classes + +- [AdminGetSwapsParams](../classes/internal-24.AdminGetSwapsParams.md) + +## Type Aliases + +### AdminSwapsListRes + +Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/swaps/index.d.ts:7 + +___ + +### AdminSwapsRes + +Ƭ **AdminSwapsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `swap` | [`Swap`](../classes/internal.Swap.md) | + +#### Defined in + +medusa/dist/api/routes/admin/swaps/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-25.md b/docs/content/references/js-client/modules/internal-25.md new file mode 100644 index 0000000000..e0f6da1541 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-25.md @@ -0,0 +1,44 @@ +# Namespace: internal + +## Classes + +- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md) +- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md) +- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md) +- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md) +- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) +- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) +- [AdminGetTaxRatesParams](../classes/internal-25.AdminGetTaxRatesParams.md) +- [AdminGetTaxRatesTaxRateParams](../classes/internal-25.AdminGetTaxRatesTaxRateParams.md) +- [AdminPostTaxRatesReq](../classes/internal-25.AdminPostTaxRatesReq.md) +- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md) +- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md) +- [AdminPostTaxRatesTaxRateReq](../classes/internal-25.AdminPostTaxRatesTaxRateReq.md) +- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md) +- [NumericalComparisonOperator](../classes/internal-25.NumericalComparisonOperator.md) + +## Type Aliases + +### AdminTaxRatesListRes + +Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/index.d.ts:8 + +___ + +### AdminTaxRatesRes + +Ƭ **AdminTaxRatesRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) | + +#### Defined in + +medusa/dist/api/routes/admin/tax-rates/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-26.md b/docs/content/references/js-client/modules/internal-26.md new file mode 100644 index 0000000000..f144fda7f1 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-26.md @@ -0,0 +1,39 @@ +# Namespace: internal + +## Classes + +- [AdminDeleteUploadsReq](../classes/internal-26.AdminDeleteUploadsReq.md) +- [AdminPostUploadsDownloadUrlReq](../classes/internal-26.AdminPostUploadsDownloadUrlReq.md) +- [IAdminPostUploadsFileReq](../classes/internal-26.IAdminPostUploadsFileReq.md) + +## Type Aliases + +### AdminUploadsDownloadUrlRes + +Ƭ **AdminUploadsDownloadUrlRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `download_url` | `string` | + +#### Defined in + +medusa/dist/api/routes/admin/uploads/index.d.ts:10 + +___ + +### AdminUploadsRes + +Ƭ **AdminUploadsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `uploads` | { `url`: `string` }[] | + +#### Defined in + +medusa/dist/api/routes/admin/uploads/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-27.md b/docs/content/references/js-client/modules/internal-27.md new file mode 100644 index 0000000000..2df72e5363 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-27.md @@ -0,0 +1,116 @@ +# Namespace: internal + +## Classes + +- [AdminCreateUserRequest](../classes/internal-27.AdminCreateUserRequest.md) +- [AdminResetPasswordRequest](../classes/internal-27.AdminResetPasswordRequest.md) +- [AdminResetPasswordTokenRequest](../classes/internal-27.AdminResetPasswordTokenRequest.md) +- [AdminUpdateUserRequest](../classes/internal-27.AdminUpdateUserRequest.md) + +## Type Aliases + +### AdminCreateUserPayload + +Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-27.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-27.md#createuserroles) } + +#### Defined in + +[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L31) + +___ + +### AdminUpdateUserPayload + +Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-27.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-27.md#updateuserroles) } + +#### Defined in + +[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L41) + +___ + +### AdminUserRes + +Ƭ **AdminUserRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | + +#### Defined in + +medusa/dist/api/routes/admin/users/index.d.ts:6 + +___ + +### AdminUsersListRes + +Ƭ **AdminUsersListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] | + +#### Defined in + +medusa/dist/api/routes/admin/users/index.d.ts:9 + +___ + +### CreateUserRoles + +Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\` + +#### Defined in + +[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L28) + +___ + +### CreateUserRolesEnum + +Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-27.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-27.AdminCreateUserRequest.md)[``"role"``]\> + +#### Defined in + +[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L25) + +___ + +### NoUndefined + +Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L23) + +___ + +### UpdateUserRoles + +Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` + +#### Defined in + +[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L39) + +___ + +### UpdateUserRolesEnum + +Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-27.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-27.AdminUpdateUserRequest.md)[``"role"``]\> + +#### Defined in + +[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L37) diff --git a/docs/content/references/js-client/modules/internal-28.md b/docs/content/references/js-client/modules/internal-28.md new file mode 100644 index 0000000000..dfecd2ff35 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-28.md @@ -0,0 +1,15 @@ +# Namespace: internal + +## Classes + +- [AdminGetVariantsParams](../classes/internal-28.AdminGetVariantsParams.md) + +## Type Aliases + +### AdminVariantsListRes + +Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/variants/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-29.md b/docs/content/references/js-client/modules/internal-29.md new file mode 100644 index 0000000000..a37efa8968 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-29.md @@ -0,0 +1,37 @@ +# Namespace: internal + +## Classes + +- [StorePostAuthReq](../classes/internal-29.StorePostAuthReq.md) + +## Type Aliases + +### StoreAuthRes + +Ƭ **StoreAuthRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer` | [`Customer`](../classes/internal.Customer.md) | + +#### Defined in + +medusa/dist/api/routes/store/auth/index.d.ts:4 + +___ + +### StoreGetAuthEmailRes + +Ƭ **StoreGetAuthEmailRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exists` | `boolean` | + +#### Defined in + +medusa/dist/api/routes/store/auth/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-3.md b/docs/content/references/js-client/modules/internal-3.md new file mode 100644 index 0000000000..fc227f83ea --- /dev/null +++ b/docs/content/references/js-client/modules/internal-3.md @@ -0,0 +1,52 @@ +# Namespace: internal + +## Classes + +- [AdminGetCollectionsPaginationParams](../classes/internal-3.AdminGetCollectionsPaginationParams.md) +- [AdminGetCollectionsParams](../classes/internal-3.AdminGetCollectionsParams.md) +- [AdminPostCollectionsCollectionReq](../classes/internal-3.AdminPostCollectionsCollectionReq.md) +- [AdminPostCollectionsReq](../classes/internal-3.AdminPostCollectionsReq.md) + +## Type Aliases + +### AdminCollectionsListRes + +Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/collections/index.d.ts:8 + +___ + +### AdminCollectionsRes + +Ƭ **AdminCollectionsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) | + +#### Defined in + +medusa/dist/api/routes/admin/collections/index.d.ts:12 + +___ + +### DeleteResponse + +Ƭ **DeleteResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `id` | `string` | +| `object` | `string` | + +#### Defined in + +medusa/dist/types/common.d.ts:64 diff --git a/docs/content/references/js-client/modules/internal-30.md b/docs/content/references/js-client/modules/internal-30.md new file mode 100644 index 0000000000..fc85db61a9 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-30.md @@ -0,0 +1,38 @@ +# Namespace: internal + +## Classes + +- [Discount](../classes/internal-30.Discount.md) +- [GiftCard](../classes/internal-30.GiftCard.md) +- [Item](../classes/internal-30.Item.md) +- [StorePostCartReq](../classes/internal-30.StorePostCartReq.md) +- [StorePostCartsCartPaymentSessionReq](../classes/internal-30.StorePostCartsCartPaymentSessionReq.md) +- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md) +- [StorePostCartsCartReq](../classes/internal-30.StorePostCartsCartReq.md) +- [StorePostCartsCartShippingMethodReq](../classes/internal-30.StorePostCartsCartShippingMethodReq.md) + +## Type Aliases + +### StoreCartsRes + +Ƭ **StoreCartsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> | + +#### Defined in + +medusa/dist/api/routes/store/carts/index.d.ts:8 + +___ + +### StoreCompleteCartRes + +Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` } + +#### Defined in + +medusa/dist/api/routes/store/carts/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-31.md b/docs/content/references/js-client/modules/internal-31.md new file mode 100644 index 0000000000..4d03367a70 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-31.md @@ -0,0 +1,31 @@ +# Namespace: internal + +## Classes + +- [StoreGetCollectionsParams](../classes/internal-31.StoreGetCollectionsParams.md) + +## Type Aliases + +### StoreCollectionsListRes + +Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] } + +#### Defined in + +medusa/dist/api/routes/store/collections/index.d.ts:7 + +___ + +### StoreCollectionsRes + +Ƭ **StoreCollectionsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) | + +#### Defined in + +medusa/dist/api/routes/store/collections/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-32.md b/docs/content/references/js-client/modules/internal-32.md new file mode 100644 index 0000000000..6c18f14c66 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-32.md @@ -0,0 +1,18 @@ +# Namespace: internal + +## Classes + +- [StoreGetCustomersCustomerOrdersParams](../classes/internal-32.StoreGetCustomersCustomerOrdersParams.md) +- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md) +- [StorePostCustomersCustomerReq](../classes/internal-32.StorePostCustomersCustomerReq.md) +- [StorePostCustomersReq](../classes/internal-32.StorePostCustomersReq.md) + +## Type Aliases + +### StoreCustomersListOrdersRes + +Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } + +#### Defined in + +medusa/dist/api/routes/store/customers/index.d.ts:12 diff --git a/docs/content/references/js-client/modules/internal-33.md b/docs/content/references/js-client/modules/internal-33.md new file mode 100644 index 0000000000..52a8616e22 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-33.md @@ -0,0 +1,17 @@ +# Namespace: internal + +## Type Aliases + +### StoreGiftCardsRes + +Ƭ **StoreGiftCardsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | + +#### Defined in + +medusa/dist/api/routes/store/gift-cards/index.d.ts:8 diff --git a/docs/content/references/js-client/modules/internal-34.md b/docs/content/references/js-client/modules/internal-34.md new file mode 100644 index 0000000000..8965788ee0 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-34.md @@ -0,0 +1,6 @@ +# Namespace: internal + +## Classes + +- [StorePostCartsCartLineItemsItemReq](../classes/internal-34.StorePostCartsCartLineItemsItemReq.md) +- [StorePostCartsCartLineItemsReq](../classes/internal-34.StorePostCartsCartLineItemsReq.md) diff --git a/docs/content/references/js-client/modules/internal-35.md b/docs/content/references/js-client/modules/internal-35.md new file mode 100644 index 0000000000..1e9186a1d8 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-35.md @@ -0,0 +1,22 @@ +# Namespace: internal + +## Classes + +- [ShippingAddressPayload](../classes/internal-35.ShippingAddressPayload.md) +- [StoreGetOrdersParams](../classes/internal-35.StoreGetOrdersParams.md) + +## Type Aliases + +### StoreOrdersRes + +Ƭ **StoreOrdersRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal.Order.md) | + +#### Defined in + +medusa/dist/api/routes/store/orders/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-36.md b/docs/content/references/js-client/modules/internal-36.md new file mode 100644 index 0000000000..4c6cd3245f --- /dev/null +++ b/docs/content/references/js-client/modules/internal-36.md @@ -0,0 +1,17 @@ +# Namespace: internal + +## Type Aliases + +### StoreCustomersListPaymentMethodsRes + +Ƭ **StoreCustomersListPaymentMethodsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] | + +#### Defined in + +medusa/dist/api/routes/store/customers/index.d.ts:15 diff --git a/docs/content/references/js-client/modules/internal-37.md b/docs/content/references/js-client/modules/internal-37.md new file mode 100644 index 0000000000..1d9b7ae74f --- /dev/null +++ b/docs/content/references/js-client/modules/internal-37.md @@ -0,0 +1,32 @@ +# Namespace: internal + +## Classes + +- [PriceSelectionParams](../classes/internal-37.PriceSelectionParams.md) +- [StoreGetVariantsParams](../classes/internal-37.StoreGetVariantsParams.md) + +## Type Aliases + +### StoreVariantsListRes + +Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] } + +#### Defined in + +medusa/dist/api/routes/store/variants/index.d.ts:9 + +___ + +### StoreVariantsRes + +Ƭ **StoreVariantsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) | + +#### Defined in + +medusa/dist/api/routes/store/variants/index.d.ts:6 diff --git a/docs/content/references/js-client/modules/internal-38.md b/docs/content/references/js-client/modules/internal-38.md new file mode 100644 index 0000000000..c6ac24c225 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-38.md @@ -0,0 +1,53 @@ +# Namespace: internal + +## Classes + +- [StoreGetProductsPaginationParams](../classes/internal-38.StoreGetProductsPaginationParams.md) +- [StoreGetProductsParams](../classes/internal-38.StoreGetProductsParams.md) +- [StorePostSearchReq](../classes/internal-38.StorePostSearchReq.md) + +## Type Aliases + +### StorePostSearchRes + +Ƭ **StorePostSearchRes**: `Object` + +#### Index signature + +▪ [k: `string`]: `unknown` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `hits` | `unknown`[] | + +#### Defined in + +medusa/dist/api/routes/store/products/index.d.ts:12 + +___ + +### StoreProductsListRes + +Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] } + +#### Defined in + +medusa/dist/api/routes/store/products/index.d.ts:16 + +___ + +### StoreProductsRes + +Ƭ **StoreProductsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `product` | [`Product`](../classes/internal.Product.md) | + +#### Defined in + +medusa/dist/api/routes/store/products/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-39.md b/docs/content/references/js-client/modules/internal-39.md new file mode 100644 index 0000000000..1235343f30 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-39.md @@ -0,0 +1,33 @@ +# Namespace: internal + +## Type Aliases + +### StoreRegionsListRes + +Ƭ **StoreRegionsListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `regions` | [`Region`](../classes/internal.Region.md)[] | + +#### Defined in + +medusa/dist/api/routes/store/regions/index.d.ts:4 + +___ + +### StoreRegionsRes + +Ƭ **StoreRegionsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `region` | [`Region`](../classes/internal.Region.md) | + +#### Defined in + +medusa/dist/api/routes/store/regions/index.d.ts:7 diff --git a/docs/content/references/js-client/modules/internal-4.md b/docs/content/references/js-client/modules/internal-4.md new file mode 100644 index 0000000000..28559e69fd --- /dev/null +++ b/docs/content/references/js-client/modules/internal-4.md @@ -0,0 +1,52 @@ +# Namespace: internal + +## Classes + +- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) +- [AdminGetCustomerGroupsGroupParams](../classes/internal-4.AdminGetCustomerGroupsGroupParams.md) +- [AdminGetCustomerGroupsParams](../classes/internal-4.AdminGetCustomerGroupsParams.md) +- [AdminGetCustomersParams](../classes/internal-4.AdminGetCustomersParams.md) +- [AdminListCustomerSelector](../classes/internal-4.AdminListCustomerSelector.md) +- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md) +- [AdminPostCustomerGroupsGroupReq](../classes/internal-4.AdminPostCustomerGroupsGroupReq.md) +- [AdminPostCustomerGroupsReq](../classes/internal-4.AdminPostCustomerGroupsReq.md) +- [CustomerGroupsBatchCustomer](../classes/internal-4.CustomerGroupsBatchCustomer.md) +- [FilterableCustomerGroupProps](../classes/internal-4.FilterableCustomerGroupProps.md) +- [FindParams](../classes/internal-4.FindParams.md) +- [StringComparisonOperator](../classes/internal-4.StringComparisonOperator.md) + +## Type Aliases + +### AdminCustomerGroupsListRes + +Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal.CustomerGroup.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/index.d.ts:9 + +___ + +### AdminCustomerGroupsRes + +Ƭ **AdminCustomerGroupsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer_group` | [`CustomerGroup`](../classes/internal.CustomerGroup.md) | + +#### Defined in + +medusa/dist/api/routes/admin/customer-groups/index.d.ts:5 + +___ + +### AdminCustomersListRes + +Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal.Customer.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/customers/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-40.md b/docs/content/references/js-client/modules/internal-40.md new file mode 100644 index 0000000000..20dac0fd61 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-40.md @@ -0,0 +1,33 @@ +# Namespace: internal + +## Type Aliases + +### StoreReturnReasonsListRes + +Ƭ **StoreReturnReasonsListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | + +#### Defined in + +medusa/dist/api/routes/store/return-reasons/index.d.ts:6 + +___ + +### StoreReturnReasonsRes + +Ƭ **StoreReturnReasonsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | + +#### Defined in + +medusa/dist/api/routes/store/return-reasons/index.d.ts:9 diff --git a/docs/content/references/js-client/modules/internal-41.md b/docs/content/references/js-client/modules/internal-41.md new file mode 100644 index 0000000000..53cd2ac774 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-41.md @@ -0,0 +1,23 @@ +# Namespace: internal + +## Classes + +- [Item](../classes/internal-41.Item.md) +- [ReturnShipping](../classes/internal-41.ReturnShipping.md) +- [StorePostReturnsReq](../classes/internal-41.StorePostReturnsReq.md) + +## Type Aliases + +### StoreReturnsRes + +Ƭ **StoreReturnsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return` | [`Return`](../classes/internal.Return.md) | + +#### Defined in + +medusa/dist/api/routes/store/returns/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-42.md b/docs/content/references/js-client/modules/internal-42.md new file mode 100644 index 0000000000..2ea7afa7bd --- /dev/null +++ b/docs/content/references/js-client/modules/internal-42.md @@ -0,0 +1,21 @@ +# Namespace: internal + +## Classes + +- [StoreGetShippingOptionsParams](../classes/internal-42.StoreGetShippingOptionsParams.md) + +## Type Aliases + +### StoreShippingOptionsListRes + +Ƭ **StoreShippingOptionsListRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] | + +#### Defined in + +medusa/dist/api/routes/store/shipping-options/index.d.ts:4 diff --git a/docs/content/references/js-client/modules/internal-43.md b/docs/content/references/js-client/modules/internal-43.md new file mode 100644 index 0000000000..86ac68a54c --- /dev/null +++ b/docs/content/references/js-client/modules/internal-43.md @@ -0,0 +1,23 @@ +# Namespace: internal + +## Classes + +- [AdditionalItem](../classes/internal-43.AdditionalItem.md) +- [Item](../classes/internal-43.Item.md) +- [StorePostSwapsReq](../classes/internal-43.StorePostSwapsReq.md) + +## Type Aliases + +### StoreSwapsRes + +Ƭ **StoreSwapsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `swap` | [`Swap`](../classes/internal.Swap.md) | + +#### Defined in + +medusa/dist/api/routes/store/swaps/index.d.ts:6 diff --git a/docs/content/references/js-client/modules/internal-5.md b/docs/content/references/js-client/modules/internal-5.md new file mode 100644 index 0000000000..9420c82978 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-5.md @@ -0,0 +1,23 @@ +# Namespace: internal + +## Classes + +- [AdminPostCustomersCustomerReq](../classes/internal-5.AdminPostCustomersCustomerReq.md) +- [AdminPostCustomersReq](../classes/internal-5.AdminPostCustomersReq.md) +- [Group](../classes/internal-5.Group.md) + +## Type Aliases + +### AdminCustomersRes + +Ƭ **AdminCustomersRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer` | [`Customer`](../classes/internal.Customer.md) | + +#### Defined in + +medusa/dist/api/routes/admin/customers/index.d.ts:5 diff --git a/docs/content/references/js-client/modules/internal-6.md b/docs/content/references/js-client/modules/internal-6.md new file mode 100644 index 0000000000..05462b8530 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-6.md @@ -0,0 +1,61 @@ +# Namespace: internal + +## Classes + +- [AdminCreateCondition](../classes/internal-6.AdminCreateCondition.md) +- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md) +- [AdminGetDiscountsDiscountRuleParams](../classes/internal-6.AdminGetDiscountsDiscountRuleParams.md) +- [AdminGetDiscountsParams](../classes/internal-6.AdminGetDiscountsParams.md) +- [AdminPostDiscountsDiscountConditions](../classes/internal-6.AdminPostDiscountsDiscountConditions.md) +- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md) +- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md) +- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md) +- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md) +- [AdminPostDiscountsDiscountReq](../classes/internal-6.AdminPostDiscountsDiscountReq.md) +- [AdminPostDiscountsDiscountRule](../classes/internal-6.AdminPostDiscountsDiscountRule.md) +- [AdminPostDiscountsReq](../classes/internal-6.AdminPostDiscountsReq.md) +- [AdminUpdateDiscountRule](../classes/internal-6.AdminUpdateDiscountRule.md) +- [AdminUpsertCondition](../classes/internal-6.AdminUpsertCondition.md) +- [AdminUpsertConditionsReq](../classes/internal-6.AdminUpsertConditionsReq.md) + +## Type Aliases + +### AdminDiscountConditionsRes + +Ƭ **AdminDiscountConditionsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `discount_condition` | [`DiscountCondition`](../classes/internal.DiscountCondition.md) | + +#### Defined in + +medusa/dist/api/routes/admin/discounts/index.d.ts:14 + +___ + +### AdminDiscountsListRes + +Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal.Discount.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/discounts/index.d.ts:18 + +___ + +### AdminDiscountsRes + +Ƭ **AdminDiscountsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `discount` | [`Discount`](../classes/internal.Discount.md) | + +#### Defined in + +medusa/dist/api/routes/admin/discounts/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-7.md b/docs/content/references/js-client/modules/internal-7.md new file mode 100644 index 0000000000..c89c0e5105 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-7.md @@ -0,0 +1,51 @@ +# Namespace: internal + +## Classes + +- [AdminGetDraftOrdersParams](../classes/internal-7.AdminGetDraftOrdersParams.md) +- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) +- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md) +- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md) +- [Discount](../classes/internal-7.Discount.md) + +## Type Aliases + +### AdminDraftOrdersListRes + +Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/internal.DraftOrder.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/index.d.ts:18 + +___ + +### AdminDraftOrdersRes + +Ƭ **AdminDraftOrdersRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `draft_order` | [`DraftOrder`](../classes/internal.DraftOrder.md) | + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/index.d.ts:14 + +___ + +### AdminPostDraftOrdersDraftOrderRegisterPaymentRes + +Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal.Order.md) | + +#### Defined in + +medusa/dist/api/routes/admin/draft-orders/index.d.ts:11 diff --git a/docs/content/references/js-client/modules/internal-8.md b/docs/content/references/js-client/modules/internal-8.md new file mode 100644 index 0000000000..be8bb16104 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-8.md @@ -0,0 +1,33 @@ +# Namespace: internal + +## Classes + +- [AdminGetGiftCardsParams](../classes/internal-8.AdminGetGiftCardsParams.md) +- [AdminPostGiftCardsGiftCardReq](../classes/internal-8.AdminPostGiftCardsGiftCardReq.md) +- [AdminPostGiftCardsReq](../classes/internal-8.AdminPostGiftCardsReq.md) + +## Type Aliases + +### AdminGiftCardsListRes + +Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal.GiftCard.md)[] } + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/index.d.ts:14 + +___ + +### AdminGiftCardsRes + +Ƭ **AdminGiftCardsRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | + +#### Defined in + +medusa/dist/api/routes/admin/gift-cards/index.d.ts:10 diff --git a/docs/content/references/js-client/modules/internal-9.md b/docs/content/references/js-client/modules/internal-9.md new file mode 100644 index 0000000000..c1b7910fb4 --- /dev/null +++ b/docs/content/references/js-client/modules/internal-9.md @@ -0,0 +1,44 @@ +# Namespace: internal + +## Classes + +- [AdminPostInvitesInviteAcceptReq](../classes/internal-9.AdminPostInvitesInviteAcceptReq.md) +- [AdminPostInvitesInviteAcceptUserReq](../classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md) +- [AdminPostInvitesReq](../classes/internal-9.AdminPostInvitesReq.md) +- [Invite](../classes/internal-9.Invite.md) + +## Type Aliases + +### AdminListInvitesRes + +Ƭ **AdminListInvitesRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `invites` | [`Invite`](../classes/internal-9.Invite.md)[] | + +#### Defined in + +medusa/dist/api/routes/admin/invites/index.d.ts:8 + +___ + +### AdminPostInvitesPayload + +Ƭ **AdminPostInvitesPayload**: `Omit`<[`AdminPostInvitesReq`](../classes/internal-9.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-9.md#inviteuserrolesenum) } + +#### Defined in + +[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L47) + +___ + +### InviteUserRolesEnum + +Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` + +#### Defined in + +[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L45) diff --git a/docs/content/references/js-client/modules/internal.md b/docs/content/references/js-client/modules/internal.md index 17d36f210f..f35ec0923a 100644 --- a/docs/content/references/js-client/modules/internal.md +++ b/docs/content/references/js-client/modules/internal.md @@ -4,22 +4,211 @@ displayed_sidebar: jsClientSidebar # Namespace: internal +## Enumerations + +- [AllocationType](../enums/internal.AllocationType.md) +- [CartType](../enums/internal.CartType.md) +- [ClaimFulfillmentStatus](../enums/internal.ClaimFulfillmentStatus.md) +- [ClaimPaymentStatus](../enums/internal.ClaimPaymentStatus.md) +- [ClaimReason](../enums/internal.ClaimReason.md) +- [ClaimType](../enums/internal.ClaimType.md) +- [DiscountConditionOperator](../enums/internal.DiscountConditionOperator.md) +- [DiscountConditionType](../enums/internal.DiscountConditionType.md) +- [DiscountRuleType](../enums/internal.DiscountRuleType.md) +- [DraftOrderStatus](../enums/internal.DraftOrderStatus.md) +- [FulfillmentStatus](../enums/internal.FulfillmentStatus.md) +- [OrderStatus](../enums/internal.OrderStatus.md) +- [PaymentStatus](../enums/internal.PaymentStatus.md) +- [PriceListStatus](../enums/internal.PriceListStatus.md) +- [PriceListType](../enums/internal.PriceListType.md) +- [ProductStatus](../enums/internal.ProductStatus.md) +- [RequirementType](../enums/internal.RequirementType.md) +- [ReturnStatus](../enums/internal.ReturnStatus.md) +- [ShippingOptionPriceType](../enums/internal.ShippingOptionPriceType.md) +- [ShippingProfileType](../enums/internal.ShippingProfileType.md) +- [SwapFulfillmentStatus](../enums/internal.SwapFulfillmentStatus.md) +- [SwapPaymentStatus](../enums/internal.SwapPaymentStatus.md) + ## Classes -- [StorePostSwapsReq](../classes/internal.StorePostSwapsReq.md) +- [Address](../classes/internal.Address.md) +- [AddressCreatePayload](../classes/internal.AddressCreatePayload.md) +- [AddressPayload](../classes/internal.AddressPayload.md) +- [Axios](../classes/internal.Axios.md) +- [BaseEntity](../classes/internal.BaseEntity.md) +- [Cart](../classes/internal.Cart.md) +- [ClaimImage](../classes/internal.ClaimImage.md) +- [ClaimItem](../classes/internal.ClaimItem.md) +- [ClaimOrder](../classes/internal.ClaimOrder.md) +- [ClaimTag](../classes/internal.ClaimTag.md) +- [Client](../classes/internal.Client.md) +- [Country](../classes/internal.Country.md) +- [Currency](../classes/internal.Currency.md) +- [Customer](../classes/internal.Customer.md) +- [CustomerGroup](../classes/internal.CustomerGroup.md) +- [Discount](../classes/internal.Discount.md) +- [DiscountCondition](../classes/internal.DiscountCondition.md) +- [DiscountRule](../classes/internal.DiscountRule.md) +- [DraftOrder](../classes/internal.DraftOrder.md) +- [Fulfillment](../classes/internal.Fulfillment.md) +- [FulfillmentItem](../classes/internal.FulfillmentItem.md) +- [FulfillmentProvider](../classes/internal.FulfillmentProvider.md) +- [GiftCard](../classes/internal.GiftCard.md) +- [GiftCardTransaction](../classes/internal.GiftCardTransaction.md) +- [Image](../classes/internal.Image.md) +- [LineItem](../classes/internal.LineItem.md) +- [LineItemAdjustment](../classes/internal.LineItemAdjustment.md) +- [LineItemTaxLine](../classes/internal.LineItemTaxLine.md) +- [MoneyAmount](../classes/internal.MoneyAmount.md) +- [Order](../classes/internal.Order.md) +- [Payment](../classes/internal.Payment.md) +- [PaymentProvider](../classes/internal.PaymentProvider.md) +- [PaymentSession](../classes/internal.PaymentSession.md) +- [PriceList](../classes/internal.PriceList.md) +- [Product](../classes/internal.Product.md) +- [ProductCollection](../classes/internal.ProductCollection.md) +- [ProductOption](../classes/internal.ProductOption.md) +- [ProductOptionValue](../classes/internal.ProductOptionValue.md) +- [ProductTag](../classes/internal.ProductTag.md) +- [ProductType](../classes/internal.ProductType.md) +- [ProductVariant](../classes/internal.ProductVariant.md) +- [Refund](../classes/internal.Refund.md) +- [Region](../classes/internal.Region.md) +- [Return](../classes/internal.Return.md) +- [ReturnItem](../classes/internal.ReturnItem.md) +- [ReturnReason](../classes/internal.ReturnReason.md) +- [SalesChannel](../classes/internal.SalesChannel.md) +- [ShippingMethod](../classes/internal.ShippingMethod.md) +- [ShippingMethodTaxLine](../classes/internal.ShippingMethodTaxLine.md) +- [ShippingOption](../classes/internal.ShippingOption.md) +- [ShippingOptionRequirement](../classes/internal.ShippingOptionRequirement.md) +- [ShippingProfile](../classes/internal.ShippingProfile.md) +- [SoftDeletableEntity](../classes/internal.SoftDeletableEntity.md) +- [StorePostCustomersCustomerAddressesAddressReq](../classes/internal.StorePostCustomersCustomerAddressesAddressReq.md) +- [StorePostCustomersCustomerAddressesReq](../classes/internal.StorePostCustomersCustomerAddressesReq.md) +- [Swap](../classes/internal.Swap.md) +- [TaxLine](../classes/internal.TaxLine.md) +- [TaxProvider](../classes/internal.TaxProvider.md) +- [TaxRate](../classes/internal.TaxRate.md) +- [TrackingLink](../classes/internal.TrackingLink.md) -## Type aliases +## Interfaces -### StoreSwapsRes +- [AxiosAdapter](../interfaces/internal.AxiosAdapter.md) +- [AxiosBasicCredentials](../interfaces/internal.AxiosBasicCredentials.md) +- [AxiosDefaults](../interfaces/internal.AxiosDefaults.md) +- [AxiosError](../interfaces/internal.AxiosError.md) +- [AxiosInstance](../interfaces/internal.AxiosInstance.md) +- [AxiosInterceptorManager](../interfaces/internal.AxiosInterceptorManager.md) +- [AxiosPromise](../interfaces/internal.AxiosPromise.md) +- [AxiosProxyConfig](../interfaces/internal.AxiosProxyConfig.md) +- [AxiosRequestConfig](../interfaces/internal.AxiosRequestConfig.md) +- [AxiosRequestTransformer](../interfaces/internal.AxiosRequestTransformer.md) +- [AxiosResponse](../interfaces/internal.AxiosResponse.md) +- [AxiosResponseTransformer](../interfaces/internal.AxiosResponseTransformer.md) +- [Cancel](../interfaces/internal.Cancel.md) +- [CancelToken](../interfaces/internal.CancelToken.md) +- [Config](../interfaces/internal.Config.md) +- [HTTPResponse](../interfaces/internal.HTTPResponse.md) +- [HeadersDefaults](../interfaces/internal.HeadersDefaults.md) +- [RequestOptions](../interfaces/internal.RequestOptions.md) +- [RetryConfig](../interfaces/internal.RetryConfig.md) +- [TransitionalOptions](../interfaces/internal.TransitionalOptions.md) -Ƭ **StoreSwapsRes**: `Object` +## Type Aliases + +### AxiosRequestHeaders + +Ƭ **AxiosRequestHeaders**: `Record`<`string`, `string`\> + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:3 + +___ + +### AxiosResponseHeaders + +Ƭ **AxiosResponseHeaders**: `Record`<`string`, `string`\> & { `set-cookie?`: `string`[] } + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:5 + +___ + +### Method + +Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"`` + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:36 + +___ + +### RequestMethod + +Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"`` + +#### Defined in + +[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/request.ts#L21) + +___ + +### Response + +Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../interfaces/internal.HTTPResponse.md) } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L17) + +___ + +### ResponsePromise + +Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](internal.md#response)<`T`\>\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | + +#### Defined in + +[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L21) + +___ + +### ResponseType + +Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"`` + +#### Defined in + +medusa-js/node_modules/axios/index.d.ts:48 + +___ + +### StoreCustomersRes + +Ƭ **StoreCustomersRes**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `swap` | [`Swap`](../classes/internal.Swap.md) | +| `customer` | `Omit`<[`Customer`](../classes/internal.Customer.md), ``"password_hash"``\> | #### Defined in -packages/medusa/dist/api/routes/store/swaps/index.d.ts:6 +medusa/dist/api/routes/store/customers/index.d.ts:9 diff --git a/docs/content/references/services/classes/AuthService.md b/docs/content/references/services/classes/AuthService.md index 5c2ec19fc4..7053ef8c0e 100644 --- a/docs/content/references/services/classes/AuthService.md +++ b/docs/content/references/services/classes/AuthService.md @@ -1,5 +1,7 @@ # Class: AuthService +Can authenticate a user based on email password combination + ## Hierarchy - `TransactionBaseService`<[`AuthService`](AuthService.md)\> @@ -24,7 +26,7 @@ TransactionBaseService<AuthService\>.constructor #### Defined in -[services/auth.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L25) +[packages/medusa/src/services/auth.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L25) ## Properties @@ -36,6 +38,10 @@ TransactionBaseService<AuthService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +52,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### customerService\_ @@ -54,7 +64,7 @@ ___ #### Defined in -[services/auth.ts:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L23) +[packages/medusa/src/services/auth.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L23) ___ @@ -68,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/auth.ts:20](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L20) +[packages/medusa/src/services/auth.ts:20](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L20) ___ @@ -82,7 +92,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/auth.ts:21](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L21) +[packages/medusa/src/services/auth.ts:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L21) ___ @@ -92,7 +102,7 @@ ___ #### Defined in -[services/auth.ts:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L22) +[packages/medusa/src/services/auth.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L22) ## Methods @@ -100,6 +110,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -111,21 +125,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -133,20 +149,27 @@ ___ ▸ **authenticate**(`email`, `password`): `Promise`<`AuthenticateResult`\> +Authenticates a given user based on an email, password combination. Uses +scrypt to match password with hashed value. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `email` | `string` | | -| `password` | `string` | | +| `email` | `string` | the email of the user | +| `password` | `string` | the password of the user | #### Returns `Promise`<`AuthenticateResult`\> +success: whether authentication succeeded + user: the user document if authentication succeded + error: a string with the error message + #### Defined in -[services/auth.ts:98](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L98) +[packages/medusa/src/services/auth.ts:98](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L98) ___ @@ -154,19 +177,25 @@ ___ ▸ **authenticateAPIToken**(`token`): `Promise`<`AuthenticateResult`\> +Authenticates a given user with an API token + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `token` | `string` | | +| `token` | `string` | the api_token of the user to authenticate | #### Returns `Promise`<`AuthenticateResult`\> +success: whether authentication succeeded + user: the user document if authentication succeded + error: a string with the error message + #### Defined in -[services/auth.ts:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L55) +[packages/medusa/src/services/auth.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L55) ___ @@ -174,20 +203,27 @@ ___ ▸ **authenticateCustomer**(`email`, `password`): `Promise`<`AuthenticateResult`\> +Authenticates a customer based on an email, password combination. Uses +scrypt to match password with hashed value. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `email` | `string` | | -| `password` | `string` | | +| `email` | `string` | the email of the user | +| `password` | `string` | the password of the user | #### Returns `Promise`<`AuthenticateResult`\> +success: whether authentication succeeded + user: the user document if authentication succeded + error: a string with the error message + #### Defined in -[services/auth.ts:147](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L147) +[packages/medusa/src/services/auth.ts:147](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L147) ___ @@ -195,20 +231,24 @@ ___ ▸ `Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\> +Verifies if a password is valid given the provided password hash + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `password` | `string` | | -| `hash` | `string` | | +| `password` | `string` | the raw password to check | +| `hash` | `string` | the hash to compare against | #### Returns `Promise`<`boolean`\> +the result of the comparison + #### Defined in -[services/auth.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/auth.ts#L39) +[packages/medusa/src/services/auth.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/auth.ts#L39) ___ @@ -232,7 +272,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -256,4 +296,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/BatchJobService.md b/docs/content/references/services/classes/BatchJobService.md index da799e71e1..374587926b 100644 --- a/docs/content/references/services/classes/BatchJobService.md +++ b/docs/content/references/services/classes/BatchJobService.md @@ -24,7 +24,7 @@ TransactionBaseService<BatchJobService\>.constructor #### Defined in -[services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L93) +[packages/medusa/src/services/batch-job.ts:93](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L93) ## Properties @@ -34,7 +34,7 @@ TransactionBaseService<BatchJobService\>.constructor #### Defined in -[services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L41) +[packages/medusa/src/services/batch-job.ts:41](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L41) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L45) +[packages/medusa/src/services/batch-job.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L45) ___ @@ -56,6 +56,10 @@ ___ TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -66,6 +70,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### eventBus\_ @@ -74,7 +82,7 @@ ___ #### Defined in -[services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L42) +[packages/medusa/src/services/batch-job.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L42) ___ @@ -88,7 +96,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L38) +[packages/medusa/src/services/batch-job.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L38) ___ @@ -98,7 +106,7 @@ ___ #### Defined in -[services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L43) +[packages/medusa/src/services/batch-job.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L43) ___ @@ -112,7 +120,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L39) +[packages/medusa/src/services/batch-job.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L39) ___ @@ -135,7 +143,7 @@ ___ #### Defined in -[services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L27) +[packages/medusa/src/services/batch-job.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L27) ## Methods @@ -143,6 +151,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -154,21 +166,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -188,7 +202,7 @@ ___ #### Defined in -[services/batch-job.ts:284](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L284) +[packages/medusa/src/services/batch-job.ts:274](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L274) ___ @@ -208,7 +222,7 @@ ___ #### Defined in -[services/batch-job.ts:266](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L266) +[packages/medusa/src/services/batch-job.ts:256](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L256) ___ @@ -228,7 +242,7 @@ ___ #### Defined in -[services/batch-job.ts:248](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L248) +[packages/medusa/src/services/batch-job.ts:238](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L238) ___ @@ -248,7 +262,7 @@ ___ #### Defined in -[services/batch-job.ts:153](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L153) +[packages/medusa/src/services/batch-job.ts:143](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L143) ___ @@ -269,7 +283,7 @@ ___ #### Defined in -[services/batch-job.ts:137](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L137) +[packages/medusa/src/services/batch-job.ts:132](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L132) ___ @@ -290,7 +304,7 @@ ___ #### Defined in -[services/batch-job.ts:380](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L380) +[packages/medusa/src/services/batch-job.ts:370](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L370) ___ @@ -311,7 +325,7 @@ ___ #### Defined in -[services/batch-job.ts:112](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L112) +[packages/medusa/src/services/batch-job.ts:112](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L112) ___ @@ -332,7 +346,7 @@ ___ #### Defined in -[services/batch-job.ts:354](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L354) +[packages/medusa/src/services/batch-job.ts:344](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L344) ___ @@ -352,7 +366,7 @@ ___ #### Defined in -[services/batch-job.ts:302](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L302) +[packages/medusa/src/services/batch-job.ts:292](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L292) ___ @@ -372,7 +386,7 @@ ___ #### Defined in -[services/batch-job.ts:334](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L334) +[packages/medusa/src/services/batch-job.ts:324](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L324) ___ @@ -396,7 +410,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -417,7 +431,7 @@ ___ #### Defined in -[services/batch-job.ts:172](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L172) +[packages/medusa/src/services/batch-job.ts:162](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L162) ___ @@ -438,7 +452,7 @@ ___ #### Defined in -[services/batch-job.ts:213](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/batch-job.ts#L213) +[packages/medusa/src/services/batch-job.ts:203](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/batch-job.ts#L203) ___ @@ -462,4 +476,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/CartService.md b/docs/content/references/services/classes/CartService.md index 4910d86241..08cd277834 100644 --- a/docs/content/references/services/classes/CartService.md +++ b/docs/content/references/services/classes/CartService.md @@ -24,7 +24,7 @@ TransactionBaseService<CartService\>.constructor #### Defined in -[services/cart.ts:107](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L107) +[packages/medusa/src/services/cart.ts:120](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L120) ## Properties @@ -34,7 +34,7 @@ TransactionBaseService<CartService\>.constructor #### Defined in -[services/cart.ts:87](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L87) +[packages/medusa/src/services/cart.ts:97](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L97) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[services/cart.ts:86](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L86) +[packages/medusa/src/services/cart.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L96) ___ @@ -56,6 +56,10 @@ ___ TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -66,6 +70,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### customShippingOptionService\_ @@ -74,7 +82,7 @@ ___ #### Defined in -[services/cart.ts:103](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L103) +[packages/medusa/src/services/cart.ts:115](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L115) ___ @@ -84,7 +92,7 @@ ___ #### Defined in -[services/cart.ts:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L96) +[packages/medusa/src/services/cart.ts:108](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L108) ___ @@ -94,7 +102,7 @@ ___ #### Defined in -[services/cart.ts:98](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L98) +[packages/medusa/src/services/cart.ts:110](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L110) ___ @@ -104,7 +112,17 @@ ___ #### Defined in -[services/cart.ts:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L90) +[packages/medusa/src/services/cart.ts:100](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L100) + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter` + +#### Defined in + +[packages/medusa/src/services/cart.ts:118](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L118) ___ @@ -114,7 +132,7 @@ ___ #### Defined in -[services/cart.ts:99](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L99) +[packages/medusa/src/services/cart.ts:111](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L111) ___ @@ -124,7 +142,7 @@ ___ #### Defined in -[services/cart.ts:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L102) +[packages/medusa/src/services/cart.ts:114](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L114) ___ @@ -134,7 +152,7 @@ ___ #### Defined in -[services/cart.ts:105](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L105) +[packages/medusa/src/services/cart.ts:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L117) ___ @@ -144,7 +162,7 @@ ___ #### Defined in -[services/cart.ts:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L89) +[packages/medusa/src/services/cart.ts:99](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L99) ___ @@ -154,7 +172,7 @@ ___ #### Defined in -[services/cart.ts:94](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L94) +[packages/medusa/src/services/cart.ts:106](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L106) ___ @@ -168,7 +186,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/cart.ts:82](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L82) +[packages/medusa/src/services/cart.ts:92](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L92) ___ @@ -178,7 +196,7 @@ ___ #### Defined in -[services/cart.ts:95](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L95) +[packages/medusa/src/services/cart.ts:107](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L107) ___ @@ -188,7 +206,7 @@ ___ #### Defined in -[services/cart.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L88) +[packages/medusa/src/services/cart.ts:98](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L98) ___ @@ -198,7 +216,7 @@ ___ #### Defined in -[services/cart.ts:104](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L104) +[packages/medusa/src/services/cart.ts:116](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L116) ___ @@ -208,7 +226,7 @@ ___ #### Defined in -[services/cart.ts:92](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L92) +[packages/medusa/src/services/cart.ts:102](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L102) ___ @@ -218,7 +236,7 @@ ___ #### Defined in -[services/cart.ts:91](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L91) +[packages/medusa/src/services/cart.ts:101](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L101) ___ @@ -228,7 +246,17 @@ ___ #### Defined in -[services/cart.ts:93](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L93) +[packages/medusa/src/services/cart.ts:105](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L105) + +___ + +### salesChannelService\_ + +• `Protected` `Readonly` **salesChannelService\_**: [`SalesChannelService`](SalesChannelService.md) + +#### Defined in + +[packages/medusa/src/services/cart.ts:104](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L104) ___ @@ -238,7 +266,7 @@ ___ #### Defined in -[services/cart.ts:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L85) +[packages/medusa/src/services/cart.ts:95](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L95) ___ @@ -248,7 +276,17 @@ ___ #### Defined in -[services/cart.ts:97](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L97) +[packages/medusa/src/services/cart.ts:109](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L109) + +___ + +### storeService\_ + +• `Protected` `Readonly` **storeService\_**: [`StoreService`](StoreService.md) + +#### Defined in + +[packages/medusa/src/services/cart.ts:103](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L103) ___ @@ -258,7 +296,7 @@ ___ #### Defined in -[services/cart.ts:100](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L100) +[packages/medusa/src/services/cart.ts:112](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L112) ___ @@ -268,7 +306,7 @@ ___ #### Defined in -[services/cart.ts:101](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L101) +[packages/medusa/src/services/cart.ts:113](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L113) ___ @@ -282,7 +320,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/cart.ts:83](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L83) +[packages/medusa/src/services/cart.ts:93](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L93) ___ @@ -300,28 +338,34 @@ ___ #### Defined in -[services/cart.ts:76](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L76) +[packages/medusa/src/services/cart.ts:86](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L86) ## Methods ### addLineItem -▸ **addLineItem**(`cartId`, `lineItem`): `Promise`<`Cart`\> +▸ **addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`Cart`\> + +Adds a line item to the cart. #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `cartId` | `string` | | -| `lineItem` | `LineItem` | | +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `cartId` | `string` | `undefined` | the id of the cart that we will add to | +| `lineItem` | `LineItem` | `undefined` | the line item to add. | +| `config` | `Object` | `undefined` | validateSalesChannels - should check if product belongs to the same sales chanel as cart (if cart has associated sales channel) | +| `config.validateSalesChannels` | `boolean` | `true` | - | #### Returns `Promise`<`Cart`\> +the result of the update operation + #### Defined in -[services/cart.ts:533](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L533) +[packages/medusa/src/services/cart.ts:606](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L606) ___ @@ -329,21 +373,29 @@ ___ ▸ **addShippingMethod**(`cartId`, `optionId`, `data?`): `Promise`<`Cart`\> +Adds the shipping method to the list of shipping methods associated with +the cart. Shipping Methods are the ways that an order is shipped, whereas a +Shipping Option is a possible way to ship an order. Shipping Methods may +also have additional details in the data field such as an id for a package +shop. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `optionId` | `string` | | -| `data` | `Record`<`string`, `unknown`\> | | +| `cartId` | `string` | the id of the cart to add shipping method to | +| `optionId` | `string` | id of shipping option to add as valid method | +| `data` | `Record`<`string`, `unknown`\> | the fulmillment data for the method | #### Returns `Promise`<`Cart`\> +the result of the update operation + #### Defined in -[services/cart.ts:1539](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1539) +[packages/medusa/src/services/cart.ts:1692](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1692) ___ @@ -351,20 +403,27 @@ ___ ▸ `Protected` **adjustFreeShipping_**(`cart`, `shouldAdd`): `Promise`<`void`\> +Ensures shipping total on cart is correct in regards to a potential free +shipping discount +If a free shipping is present, we set shipping methods price to 0 +if a free shipping was present, we set shipping methods to original amount + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cart` | `Cart` | | -| `shouldAdd` | `boolean` | | +| `cart` | `Cart` | the the cart to adjust free shipping for | +| `shouldAdd` | `boolean` | flag to indicate, if we should add or remove | #### Returns `Promise`<`void`\> +void + #### Defined in -[services/cart.ts:685](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L685) +[packages/medusa/src/services/cart.ts:773](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L773) ___ @@ -372,20 +431,27 @@ ___ ▸ **applyDiscount**(`cart`, `discountCode`): `Promise`<`void`\> +Updates the cart's discounts. +If discount besides free shipping is already applied, this +will be overwritten +Throws if discount regions does not include the cart region + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cart` | `Cart` | | -| `discountCode` | `string` | | +| `cart` | `Cart` | the cart to update | +| `discountCode` | `string` | the discount code | #### Returns `Promise`<`void`\> +the result of the update operation + #### Defined in -[services/cart.ts:1056](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1056) +[packages/medusa/src/services/cart.ts:1209](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1209) ___ @@ -406,7 +472,7 @@ ___ #### Defined in -[services/cart.ts:1020](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1020) +[packages/medusa/src/services/cart.ts:1173](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1173) ___ @@ -414,6 +480,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -425,21 +495,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -447,20 +519,28 @@ ___ ▸ **authorizePayment**(`cartId`, `context?`): `Promise`<`Cart`\> +Authorizes a payment for a cart. +Will authorize with chosen payment provider. This will return +a payment object, that we will use to update our cart payment with. +Additionally, if the payment does not require more or fails, we will +set the payment on the cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `context` | `Record`<`string`, `unknown`\> | | +| `cartId` | `string` | the id of the cart to authorize payment for | +| `context` | `Record`<`string`, `unknown`\> | object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling. | #### Returns `Promise`<`Cart`\> +the resulting cart + #### Defined in -[services/cart.ts:1195](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1195) +[packages/medusa/src/services/cart.ts:1348](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1348) ___ @@ -468,19 +548,23 @@ ___ ▸ **create**(`data`): `Promise`<`Cart`\> +Creates a cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `CartCreateProps` | | +| `data` | `CartCreateProps` | the data to create the cart with | #### Returns `Promise`<`Cart`\> +the result of the create operation + #### Defined in -[services/cart.ts:334](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L334) +[packages/medusa/src/services/cart.ts:343](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L343) ___ @@ -488,19 +572,23 @@ ___ ▸ `Protected` **createOrFetchUserFromEmail_**(`email`): `Promise`<`Customer`\> +Creates or fetches a user based on an email. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `email` | `string` | | +| `email` | `string` | the email to use | #### Returns `Promise`<`Customer`\> +the resultign customer object + #### Defined in -[services/cart.ts:898](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L898) +[packages/medusa/src/services/cart.ts:1051](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1051) ___ @@ -520,7 +608,7 @@ ___ #### Defined in -[services/cart.ts:1940](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1940) +[packages/medusa/src/services/cart.ts:2093](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L2093) ___ @@ -542,7 +630,7 @@ ___ #### Defined in -[services/cart.ts:209](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L209) +[packages/medusa/src/services/cart.ts:228](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L228) ___ @@ -550,19 +638,23 @@ ___ ▸ **delete**(`cartId`): `Promise`<`Cart`\> +Deletes a cart from the database. Completed carts cannot be deleted. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | +| `cartId` | `string` | the id of the cart to delete | #### Returns `Promise`<`Cart`\> +the deleted cart or undefined if the cart was not found. + #### Defined in -[services/cart.ts:1855](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1855) +[packages/medusa/src/services/cart.ts:2008](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L2008) ___ @@ -570,20 +662,24 @@ ___ ▸ **deleteMetadata**(`cartId`, `key`): `Promise`<`Cart`\> +Dedicated method to delete metadata for a cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `key` | `string` | | +| `cartId` | `string` | the cart to delete metadata from. | +| `key` | `string` | key for metadata field | #### Returns `Promise`<`Cart`\> +resolves to the updated result. + #### Defined in -[services/cart.ts:1997](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1997) +[packages/medusa/src/services/cart.ts:2150](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L2150) ___ @@ -591,20 +687,24 @@ ___ ▸ **deletePaymentSession**(`cartId`, `providerId`): `Promise`<`Cart`\> +Removes a payment session from the cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `providerId` | `string` | | +| `cartId` | `string` | the id of the cart to remove from | +| `providerId` | `string` | the id of the provider whoose payment session should be removed. | #### Returns `Promise`<`Cart`\> +the resulting cart. + #### Defined in -[services/cart.ts:1447](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1447) +[packages/medusa/src/services/cart.ts:1600](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1600) ___ @@ -612,20 +712,45 @@ ___ ▸ **findCustomShippingOption**(`cartCustomShippingOptions`, `optionId`): `undefined` \| `CustomShippingOption` +Finds the cart's custom shipping options based on the passed option id. +throws if custom options is not empty and no shipping option corresponds to optionId + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartCustomShippingOptions` | `CustomShippingOption`[] | | -| `optionId` | `string` | | +| `cartCustomShippingOptions` | `CustomShippingOption`[] | the cart's custom shipping options | +| `optionId` | `string` | id of the normal or custom shipping option to find in the cartCustomShippingOptions | #### Returns `undefined` \| `CustomShippingOption` +custom shipping option + #### Defined in -[services/cart.ts:1643](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1643) +[packages/medusa/src/services/cart.ts:1796](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1796) + +___ + +### getValidatedSalesChannel + +▸ `Protected` **getValidatedSalesChannel**(`salesChannelId?`): `Promise`<`SalesChannel`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `salesChannelId?` | `string` | + +#### Returns + +`Promise`<`SalesChannel`\> + +#### Defined in + +[packages/medusa/src/services/cart.ts:446](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L446) ___ @@ -637,16 +762,43 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableCartProps` | | -| `config` | `FindConfig`<`Cart`\> | | +| `selector` | `FilterableCartProps` | the query object for find | +| `config` | `FindConfig`<`Cart`\> | config object | #### Returns `Promise`<`Cart`[]\> +the result of the find operation + #### Defined in -[services/cart.ts:259](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L259) +[packages/medusa/src/services/cart.ts:278](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L278) + +___ + +### onSalesChannelChange + +▸ `Protected` **onSalesChannelChange**(`cart`, `newSalesChannelId`): `Promise`<`void`\> + +Remove the cart line item that does not belongs to the newly assigned sales channel + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | `Cart` | The cart being updated | +| `newSalesChannelId` | `string` | The new sales channel being assigned to the cart | + +#### Returns + +`Promise`<`void`\> + +void + +#### Defined in + +[packages/medusa/src/services/cart.ts:997](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L997) ___ @@ -666,7 +818,7 @@ ___ #### Defined in -[services/cart.ts:1971](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1971) +[packages/medusa/src/services/cart.ts:2124](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L2124) ___ @@ -674,20 +826,24 @@ ___ ▸ **refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`Cart`\> +Refreshes a payment session on a cart + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `providerId` | `string` | | +| `cartId` | `string` | the id of the cart to remove from | +| `providerId` | `string` | the id of the provider whoose payment session should be removed. | #### Returns `Promise`<`Cart`\> +the resulting cart. + #### Defined in -[services/cart.ts:1495](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1495) +[packages/medusa/src/services/cart.ts:1648](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1648) ___ @@ -695,20 +851,24 @@ ___ ▸ **removeDiscount**(`cartId`, `discountCode`): `Promise`<`Cart`\> +Removes a discount based on a discount code. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `discountCode` | `string` | | +| `cartId` | `string` | the id of the cart to remove from | +| `discountCode` | `string` | the discount code to remove | #### Returns `Promise`<`Cart`\> +the resulting cart + #### Defined in -[services/cart.ts:1116](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1116) +[packages/medusa/src/services/cart.ts:1269](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1269) ___ @@ -716,20 +876,24 @@ ___ ▸ **removeLineItem**(`cartId`, `lineItemId`): `Promise`<`Cart`\> +Removes a line item from the cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `lineItemId` | `string` | | +| `cartId` | `string` | the id of the cart that we will remove from | +| `lineItemId` | `string` | the line item to remove. | #### Returns `Promise`<`Cart`\> +the result of the update operation + #### Defined in -[services/cart.ts:437](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L437) +[packages/medusa/src/services/cart.ts:478](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L478) ___ @@ -737,21 +901,25 @@ ___ ▸ **retrieve**(`cartId`, `options?`, `totalsConfig?`): `Promise`<`Cart`\> +Gets a cart by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `options` | `FindConfig`<`Cart`\> | | -| `totalsConfig` | `TotalsConfig` | | +| `cartId` | `string` | the id of the cart to get. | +| `options` | `FindConfig`<`Cart`\> | the options to get a cart | +| `totalsConfig` | `TotalsConfig` | configuration for retrieval of totals | #### Returns `Promise`<`Cart`\> +the cart document. + #### Defined in -[services/cart.ts:282](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L282) +[packages/medusa/src/services/cart.ts:296](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L296) ___ @@ -759,21 +927,27 @@ ___ ▸ **setMetadata**(`cartId`, `key`, `value`): `Promise`<`Cart`\> +Dedicated method to set metadata for a cart. +To ensure that plugins does not overwrite each +others metadata fields, setMetadata is provided. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `key` | `string` | | -| `value` | `string` \| `number` | | +| `cartId` | `string` | the cart to apply metadata to. | +| `key` | `string` | key for metadata field | +| `value` | `string` \| `number` | value for metadata field. | #### Returns `Promise`<`Cart`\> +resolves to the updated result. + #### Defined in -[services/cart.ts:1898](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1898) +[packages/medusa/src/services/cart.ts:2051](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L2051) ___ @@ -781,20 +955,24 @@ ___ ▸ **setPaymentSession**(`cartId`, `providerId`): `Promise`<`Cart`\> +Sets a payment method for a cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `providerId` | `string` | | +| `cartId` | `string` | the id of the cart to add payment method to | +| `providerId` | `string` | the id of the provider to be set to the cart | #### Returns `Promise`<`Cart`\> +result of update operation + #### Defined in -[services/cart.ts:1266](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1266) +[packages/medusa/src/services/cart.ts:1419](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1419) ___ @@ -802,19 +980,27 @@ ___ ▸ **setPaymentSessions**(`cartOrCartId`): `Promise`<`void`\> +Creates, updates and sets payment sessions associated with the cart. The +first time the method is called payment sessions will be created for each +provider. Additional calls will ensure that payment sessions have correct +amounts, currencies, etc. as well as make sure to filter payment sessions +that are not available for the cart's region. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrCartId` | `string` \| `Cart` | | +| `cartOrCartId` | `string` \| `Cart` | the id of the cart to set payment session for | #### Returns `Promise`<`void`\> +the result of the update operation. + #### Defined in -[services/cart.ts:1339](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1339) +[packages/medusa/src/services/cart.ts:1492](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1492) ___ @@ -822,21 +1008,25 @@ ___ ▸ `Protected` **setRegion_**(`cart`, `regionId`, `countryCode`): `Promise`<`void`\> +Set's the region of a cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cart` | `Cart` | | -| `regionId` | `string` | | -| `countryCode` | ``null`` \| `string` | | +| `cart` | `Cart` | the cart to set region on | +| `regionId` | `string` | the id of the region to set the region to | +| `countryCode` | ``null`` \| `string` | the country code to set the country to | #### Returns `Promise`<`void`\> +the result of the update operation + #### Defined in -[services/cart.ts:1722](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1722) +[packages/medusa/src/services/cart.ts:1875](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1875) ___ @@ -860,7 +1050,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -880,7 +1070,7 @@ ___ #### Defined in -[services/cart.ts:158](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L158) +[packages/medusa/src/services/cart.ts:177](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L177) ___ @@ -901,7 +1091,7 @@ ___ #### Defined in -[services/cart.ts:728](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L728) +[packages/medusa/src/services/cart.ts:816](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L816) ___ @@ -909,21 +1099,25 @@ ___ ▸ `Protected` **updateBillingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> +Updates the cart's billing address. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cart` | `Cart` | | -| `addressOrId` | `string` \| `AddressPayload` \| `Partial`<`Address`\> | | -| `addrRepo` | `AddressRepository` | | +| `cart` | `Cart` | the cart to update | +| `addressOrId` | `string` \| `AddressPayload` \| `Partial`<`Address`\> | the value to set the billing address to | +| `addrRepo` | `AddressRepository` | the repository to use for address updates | #### Returns `Promise`<`void`\> +the result of the update operation + #### Defined in -[services/cart.ts:931](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L931) +[packages/medusa/src/services/cart.ts:1084](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1084) ___ @@ -931,20 +1125,24 @@ ___ ▸ `Protected` **updateCustomerId_**(`cart`, `customerId`): `Promise`<`void`\> +Sets the customer id of a cart + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cart` | `Cart` | | -| `customerId` | `string` | | +| `cart` | `Cart` | the cart to add email to | +| `customerId` | `string` | the customer to add to cart | #### Returns `Promise`<`void`\> +the result of the update operation + #### Defined in -[services/cart.ts:880](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L880) +[packages/medusa/src/services/cart.ts:1033](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1033) ___ @@ -952,21 +1150,25 @@ ___ ▸ **updateLineItem**(`cartId`, `lineItemId`, `lineItemUpdate`): `Promise`<`Cart`\> +Updates a cart's existing line item. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `lineItemId` | `string` | | -| `lineItemUpdate` | `LineItemUpdate` | | +| `cartId` | `string` | the id of the cart to update | +| `lineItemId` | `string` | the id of the line item to update. | +| `lineItemUpdate` | `LineItemUpdate` | the line item to update. Must include an id field. | #### Returns `Promise`<`Cart`\> +the result of the update operation + #### Defined in -[services/cart.ts:620](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L620) +[packages/medusa/src/services/cart.ts:708](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L708) ___ @@ -974,20 +1176,24 @@ ___ ▸ **updatePaymentSession**(`cartId`, `update`): `Promise`<`Cart`\> +Updates the currently selected payment session. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `update` | `object` | | +| `cartId` | `string` | the id of the cart to update the payment session for | +| `update` | `object` | the data to update the payment session with | #### Returns `Promise`<`Cart`\> +the resulting cart + #### Defined in -[services/cart.ts:1160](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1160) +[packages/medusa/src/services/cart.ts:1313](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1313) ___ @@ -995,21 +1201,25 @@ ___ ▸ `Protected` **updateShippingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> +Updates the cart's shipping address. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cart` | `Cart` | | -| `addressOrId` | `string` \| `AddressPayload` \| `Partial`<`Address`\> | | -| `addrRepo` | `AddressRepository` | | +| `cart` | `Cart` | the cart to update | +| `addressOrId` | `string` \| `AddressPayload` \| `Partial`<`Address`\> | the value to set the shipping address to | +| `addrRepo` | `AddressRepository` | the repository to use for address updates | #### Returns `Promise`<`void`\> +the result of the update operation + #### Defined in -[services/cart.ts:971](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L971) +[packages/medusa/src/services/cart.ts:1124](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1124) ___ @@ -1031,7 +1241,32 @@ ___ #### Defined in -[services/cart.ts:1662](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L1662) +[packages/medusa/src/services/cart.ts:1815](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L1815) + +___ + +### validateLineItem + +▸ `Protected` **validateLineItem**(`cart`, `lineItem`): `Promise`<`boolean`\> + +Check if line item's variant belongs to the cart's sales channel. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | `Cart` | the cart for the line item | +| `lineItem` | `LineItem` | the line item being added | + +#### Returns + +`Promise`<`boolean`\> + +a boolean indicating validation result + +#### Defined in + +[packages/medusa/src/services/cart.ts:575](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L575) ___ @@ -1039,20 +1274,26 @@ ___ ▸ `Protected` **validateLineItemShipping_**(`shippingMethods`, `lineItem`): `boolean` +Checks if a given line item has a shipping method that can fulfill it. +Returns true if all products in the cart can be fulfilled with the current +shipping methods. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `shippingMethods` | `ShippingMethod`[] | | -| `lineItem` | `LineItem` | | +| `shippingMethods` | `ShippingMethod`[] | the set of shipping methods to check from | +| `lineItem` | `LineItem` | the line item | #### Returns `boolean` +boolean representing whether shipping method is validated + #### Defined in -[services/cart.ts:503](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/cart.ts#L503) +[packages/medusa/src/services/cart.ts:544](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/cart.ts#L544) ___ @@ -1076,4 +1317,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/ClaimItemService.md b/docs/content/references/services/classes/ClaimItemService.md index 3fffdb6c81..3f52df985a 100644 --- a/docs/content/references/services/classes/ClaimItemService.md +++ b/docs/content/references/services/classes/ClaimItemService.md @@ -24,7 +24,7 @@ BaseService<ClaimItemService\>.constructor #### Defined in -[services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L30) +[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L30) ## Properties @@ -34,7 +34,7 @@ BaseService<ClaimItemService\>.constructor #### Defined in -[services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L25) +[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L25) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L23) +[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L23) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L24) +[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L24) ___ @@ -66,6 +66,10 @@ ___ BaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -76,6 +80,10 @@ ___ BaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### eventBus\_ @@ -84,7 +92,7 @@ ___ #### Defined in -[services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L22) +[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L22) ___ @@ -94,7 +102,7 @@ ___ #### Defined in -[services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L21) +[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L21) ___ @@ -108,7 +116,7 @@ BaseService.manager\_ #### Defined in -[services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L27) +[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L27) ___ @@ -122,7 +130,7 @@ BaseService.transactionManager\_ #### Defined in -[services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L28) +[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L28) ___ @@ -140,7 +148,7 @@ ___ #### Defined in -[services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L15) +[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L15) ## Methods @@ -148,6 +156,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -159,21 +171,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from BaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -193,7 +207,7 @@ ___ #### Defined in -[services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L49) +[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L49) ___ @@ -205,16 +219,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`ClaimItem`\> | | -| `config` | `FindConfig`<`ClaimItem`\> | | +| `selector` | `Selector`<`ClaimItem`\> | the query object for find | +| `config` | `FindConfig`<`ClaimItem`\> | the config object for find | #### Returns `Promise`<`ClaimItem`[]\> +the result of the find operation + #### Defined in -[services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L214) +[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L214) ___ @@ -222,20 +238,24 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimItem`\> +Gets a claim item by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `FindConfig`<`ClaimItem`\> | | +| `id` | `string` | id of ClaimItem to retrieve | +| `config` | `FindConfig`<`ClaimItem`\> | configuration for the find operation | #### Returns `Promise`<`ClaimItem`\> +the ClaimItem + #### Defined in -[services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L233) +[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L233) ___ @@ -259,7 +279,7 @@ BaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -280,7 +300,7 @@ ___ #### Defined in -[services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim-item.ts#L132) +[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim-item.ts#L132) ___ @@ -304,4 +324,4 @@ BaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/ClaimService.md b/docs/content/references/services/classes/ClaimService.md index c0c3c5fb18..71fad9df25 100644 --- a/docs/content/references/services/classes/ClaimService.md +++ b/docs/content/references/services/classes/ClaimService.md @@ -27,7 +27,7 @@ TransactionBaseService< #### Defined in -[services/claim.ts:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L85) +[packages/medusa/src/services/claim.ts:85](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L85) ## Properties @@ -37,7 +37,7 @@ TransactionBaseService< #### Defined in -[services/claim.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L68) +[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L68) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[services/claim.ts:72](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L72) +[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L72) ___ @@ -57,7 +57,7 @@ ___ #### Defined in -[services/claim.ts:69](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L69) +[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L69) ___ @@ -69,6 +69,10 @@ ___ TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -79,6 +83,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### eventBus\_ @@ -87,7 +95,7 @@ ___ #### Defined in -[services/claim.ts:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L73) +[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L73) ___ @@ -97,7 +105,7 @@ ___ #### Defined in -[services/claim.ts:74](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L74) +[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L74) ___ @@ -107,7 +115,7 @@ ___ #### Defined in -[services/claim.ts:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L75) +[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L75) ___ @@ -117,7 +125,7 @@ ___ #### Defined in -[services/claim.ts:76](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L76) +[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L76) ___ @@ -127,7 +135,7 @@ ___ #### Defined in -[services/claim.ts:71](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L71) +[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L71) ___ @@ -137,7 +145,7 @@ ___ #### Defined in -[services/claim.ts:77](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L77) +[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L77) ___ @@ -151,7 +159,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/claim.ts:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L65) +[packages/medusa/src/services/claim.ts:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L65) ___ @@ -161,7 +169,7 @@ ___ #### Defined in -[services/claim.ts:78](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L78) +[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L78) ___ @@ -171,7 +179,7 @@ ___ #### Defined in -[services/claim.ts:79](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L79) +[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L79) ___ @@ -181,7 +189,7 @@ ___ #### Defined in -[services/claim.ts:80](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L80) +[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L80) ___ @@ -191,7 +199,7 @@ ___ #### Defined in -[services/claim.ts:70](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L70) +[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L70) ___ @@ -201,7 +209,7 @@ ___ #### Defined in -[services/claim.ts:81](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L81) +[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L81) ___ @@ -211,7 +219,7 @@ ___ #### Defined in -[services/claim.ts:82](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L82) +[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L82) ___ @@ -221,7 +229,7 @@ ___ #### Defined in -[services/claim.ts:83](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L83) +[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L83) ___ @@ -235,7 +243,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/claim.ts:66](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L66) +[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L66) ___ @@ -256,7 +264,7 @@ ___ #### Defined in -[services/claim.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L56) +[packages/medusa/src/services/claim.ts:56](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L56) ## Methods @@ -264,6 +272,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -275,21 +287,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -309,7 +323,7 @@ ___ #### Defined in -[services/claim.ts:753](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L753) +[packages/medusa/src/services/claim.ts:753](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L753) ___ @@ -329,7 +343,7 @@ ___ #### Defined in -[services/claim.ts:602](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L602) +[packages/medusa/src/services/claim.ts:602](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L602) ___ @@ -337,19 +351,25 @@ ___ ▸ **create**(`data`): `Promise`<`ClaimOrder`\> +Creates a Claim on an Order. Claims consists of items that are claimed and +optionally items to be sent as replacement for the claimed items. The +shipping address that the new items will be shipped to + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `CreateClaimInput` | | +| `data` | `CreateClaimInput` | the object containing all data required to create a claim | #### Returns `Promise`<`ClaimOrder`\> +created claim + #### Defined in -[services/claim.ts:217](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L217) +[packages/medusa/src/services/claim.ts:217](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L217) ___ @@ -361,18 +381,20 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `Object` | | -| `config.metadata?` | `Record`<`string`, `unknown`\> | | -| `config.no_notification?` | `boolean` | | +| `id` | `string` | the object containing all data required to create a claim | +| `config` | `Object` | config object | +| `config.metadata?` | `Record`<`string`, `unknown`\> | config metadata | +| `config.no_notification?` | `boolean` | config no notification | #### Returns `Promise`<`ClaimOrder`\> +created claim + #### Defined in -[services/claim.ts:456](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L456) +[packages/medusa/src/services/claim.ts:456](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L456) ___ @@ -397,7 +419,7 @@ ___ #### Defined in -[services/claim.ts:674](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L674) +[packages/medusa/src/services/claim.ts:674](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L674) ___ @@ -409,16 +431,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `FindConfig`<`ClaimOrder`\> | | +| `selector` | `any` | the query object for find | +| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings | #### Returns `Promise`<`ClaimOrder`[]\> +the result of the find operation + #### Defined in -[services/claim.ts:809](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L809) +[packages/medusa/src/services/claim.ts:809](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L809) ___ @@ -438,7 +462,7 @@ ___ #### Defined in -[services/claim.ts:628](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L628) +[packages/medusa/src/services/claim.ts:628](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L628) ___ @@ -446,20 +470,24 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimOrder`\> +Gets an order by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `FindConfig`<`ClaimOrder`\> | | +| `id` | `string` | id of the claim order to retrieve | +| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings | #### Returns `Promise`<`ClaimOrder`\> +the order document + #### Defined in -[services/claim.ts:834](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L834) +[packages/medusa/src/services/claim.ts:829](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L829) ___ @@ -483,7 +511,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -504,7 +532,7 @@ ___ #### Defined in -[services/claim.ts:127](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L127) +[packages/medusa/src/services/claim.ts:127](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L127) ___ @@ -528,4 +556,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/CustomShippingOptionService.md b/docs/content/references/services/classes/CustomShippingOptionService.md index 323c0f23ce..589a8dddfa 100644 --- a/docs/content/references/services/classes/CustomShippingOptionService.md +++ b/docs/content/references/services/classes/CustomShippingOptionService.md @@ -24,7 +24,7 @@ TransactionBaseService<CustomShippingOptionService\>.constructor #### Defined in -[services/custom-shipping-option.ts:19](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L19) +[packages/medusa/src/services/custom-shipping-option.ts:19](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L19) ## Properties @@ -36,6 +36,10 @@ TransactionBaseService<CustomShippingOptionService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +50,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### customShippingOptionRepository\_ @@ -54,7 +62,7 @@ ___ #### Defined in -[services/custom-shipping-option.ts:17](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L17) +[packages/medusa/src/services/custom-shipping-option.ts:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L17) ___ @@ -68,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L15) +[packages/medusa/src/services/custom-shipping-option.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L15) ___ @@ -82,7 +90,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L16) +[packages/medusa/src/services/custom-shipping-option.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L16) ## Methods @@ -90,6 +98,10 @@ TransactionBaseService.transactionManager\_ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -101,21 +113,23 @@ TransactionBaseService.transactionManager\_ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -123,19 +137,23 @@ ___ ▸ **create**(`data`): `Promise`<`CustomShippingOption`\> +Creates a custom shipping option + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `CreateCustomShippingOptionInput` | | +| `data` | `CreateCustomShippingOptionInput` | the custom shipping option to create | #### Returns `Promise`<`CustomShippingOption`\> +resolves to the creation result + #### Defined in -[services/custom-shipping-option.ts:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L90) +[packages/medusa/src/services/custom-shipping-option.ts:88](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L88) ___ @@ -143,20 +161,24 @@ ___ ▸ **list**(`selector`, `config?`): `Promise`<`CustomShippingOption`[]\> +Fetches all custom shipping options based on the given selector + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`CustomShippingOption`\> | | -| `config` | `FindConfig`<`CustomShippingOption`\> | | +| `selector` | `Selector`<`CustomShippingOption`\> | the query object for find | +| `config` | `FindConfig`<`CustomShippingOption`\> | the configuration used to find the objects. contains relations, skip, and take. | #### Returns `Promise`<`CustomShippingOption`[]\> +custom shipping options matching the query + #### Defined in -[services/custom-shipping-option.ts:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L65) +[packages/medusa/src/services/custom-shipping-option.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L64) ___ @@ -164,20 +186,24 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`CustomShippingOption`\> +Retrieves a specific shipping option. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `FindConfig`<`CustomShippingOption`\> | | +| `id` | `string` | the id of the custom shipping option to retrieve. | +| `config` | `FindConfig`<`CustomShippingOption`\> | any options needed to query for the result. | #### Returns `Promise`<`CustomShippingOption`\> +the requested custom shipping option. + #### Defined in -[services/custom-shipping-option.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/custom-shipping-option.ts#L36) +[packages/medusa/src/services/custom-shipping-option.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/custom-shipping-option.ts#L36) ___ @@ -201,7 +227,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -225,4 +251,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/CustomerGroupService.md b/docs/content/references/services/classes/CustomerGroupService.md index 71ef5fe74d..123a150f37 100644 --- a/docs/content/references/services/classes/CustomerGroupService.md +++ b/docs/content/references/services/classes/CustomerGroupService.md @@ -1,5 +1,9 @@ # Class: CustomerGroupService +Provides layer to manipulate discounts. + +**`Implements`** + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +28,7 @@ BaseService.constructor #### Defined in -[services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L31) +[packages/medusa/src/services/customer-group.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L31) ## Properties @@ -34,7 +38,7 @@ BaseService.constructor #### Defined in -[services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L27) +[packages/medusa/src/services/customer-group.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L27) ___ @@ -44,7 +48,7 @@ ___ #### Defined in -[services/customer-group.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L29) +[packages/medusa/src/services/customer-group.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L29) ___ @@ -54,7 +58,7 @@ ___ #### Defined in -[services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L25) +[packages/medusa/src/services/customer-group.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L25) ## Methods @@ -62,20 +66,24 @@ ___ ▸ **addCustomers**(`id`, `customerIds`): `Promise`<`CustomerGroup`\> +Add a batch of customers to a customer group at once + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `customerIds` | `string` \| `string`[] | | +| `id` | `string` | id of the customer group to add customers to | +| `customerIds` | `string` \| `string`[] | customer id's to add to the group | #### Returns `Promise`<`CustomerGroup`\> +the customer group after insertion + #### Defined in -[services/customer-group.ts:113](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L113) +[packages/medusa/src/services/customer-group.ts:113](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L113) ___ @@ -83,11 +91,13 @@ ___ ▸ **create**(`group`): `Promise`<`CustomerGroup`\> +Creates a customer group with the provided data. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `group` | `Object` | | +| `group` | `Object` | the customer group to create | | `group.created_at?` | { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - | | `group.customers?` | (`undefined` \| { email?: string \| undefined; first\_name?: string \| undefined; last\_name?: string \| undefined; billing\_address\_id?: string \| null \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 10 more ...; updated\_at?: { ...; } \| undef...)[] | - | | `group.deleted_at?` | ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } | - | @@ -101,9 +111,11 @@ ___ `Promise`<`CustomerGroup`\> +the result of the create operation + #### Defined in -[services/customer-group.ts:86](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L86) +[packages/medusa/src/services/customer-group.ts:86](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L86) ___ @@ -111,19 +123,23 @@ ___ ▸ **delete**(`groupId`): `Promise`<`void`\> +Remove customer group + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `groupId` | `string` | | +| `groupId` | `string` | id of the customer group to delete | #### Returns `Promise`<`void`\> +a promise + #### Defined in -[services/customer-group.ts:194](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L194) +[packages/medusa/src/services/customer-group.ts:194](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L194) ___ @@ -131,20 +147,24 @@ ___ ▸ **list**(`selector?`, `config`): `Promise`<`CustomerGroup`[]\> +List customer groups. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableCustomerGroupProps` | | -| `config` | `FindConfig`<`CustomerGroup`\> | | +| `selector` | `FilterableCustomerGroupProps` | the query object for find | +| `config` | `FindConfig`<`CustomerGroup`\> | the config to be used for find | #### Returns `Promise`<`CustomerGroup`[]\> +the result of the find operation + #### Defined in -[services/customer-group.ts:217](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L217) +[packages/medusa/src/services/customer-group.ts:217](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L217) ___ @@ -152,20 +172,24 @@ ___ ▸ **listAndCount**(`selector?`, `config`): `Promise`<[`CustomerGroup`[], `number`]\> +Retrieve a list of customer groups and total count of records that match the query. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableCustomerGroupProps` | | -| `config` | `FindConfig`<`CustomerGroup`\> | | +| `selector` | `FilterableCustomerGroupProps` | the query object for find | +| `config` | `FindConfig`<`CustomerGroup`\> | the config to be used for find | #### Returns `Promise`<[`CustomerGroup`[], `number`]\> +the result of the find operation + #### Defined in -[services/customer-group.ts:236](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L236) +[packages/medusa/src/services/customer-group.ts:236](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L236) ___ @@ -173,20 +197,24 @@ ___ ▸ **removeCustomer**(`id`, `customerIds`): `Promise`<`CustomerGroup`\> +Remove list of customers from a customergroup + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `customerIds` | `string` \| `string`[] | | +| `id` | `string` | id of the customer group from which the customers are removed | +| `customerIds` | `string` \| `string`[] | id's of the customer to remove from group | #### Returns `Promise`<`CustomerGroup`\> +the customergroup with the provided id + #### Defined in -[services/customer-group.ts:271](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L271) +[packages/medusa/src/services/customer-group.ts:271](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L271) ___ @@ -207,7 +235,7 @@ ___ #### Defined in -[services/customer-group.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L62) +[packages/medusa/src/services/customer-group.ts:62](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L62) ___ @@ -215,20 +243,24 @@ ___ ▸ **update**(`customerGroupId`, `update`): `Promise`<`CustomerGroup`[]\> +Update a customer group. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `customerGroupId` | `string` | | -| `update` | `CustomerGroupUpdate` | | +| `customerGroupId` | `string` | id of the customer group | +| `update` | `CustomerGroupUpdate` | customer group partial data | #### Returns `Promise`<`CustomerGroup`[]\> +resulting customer group + #### Defined in -[services/customer-group.ts:162](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L162) +[packages/medusa/src/services/customer-group.ts:162](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L162) ___ @@ -248,4 +280,4 @@ ___ #### Defined in -[services/customer-group.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer-group.ts#L46) +[packages/medusa/src/services/customer-group.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer-group.ts#L46) diff --git a/docs/content/references/services/classes/CustomerService.md b/docs/content/references/services/classes/CustomerService.md index f024ac4113..f63dffdc4c 100644 --- a/docs/content/references/services/classes/CustomerService.md +++ b/docs/content/references/services/classes/CustomerService.md @@ -1,5 +1,7 @@ # Class: CustomerService +Provides layer to manipulate customers. + ## Hierarchy - `TransactionBaseService`<[`CustomerService`](CustomerService.md)\> @@ -24,7 +26,7 @@ TransactionBaseService<CustomerService\>.constructor #### Defined in -[services/customer.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L40) +[packages/medusa/src/services/customer.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L39) ## Properties @@ -34,7 +36,7 @@ TransactionBaseService<CustomerService\>.constructor #### Defined in -[services/customer.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L28) +[packages/medusa/src/services/customer.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L27) ___ @@ -46,6 +48,10 @@ ___ TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -56,6 +62,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### customerRepository\_ @@ -64,7 +74,7 @@ ___ #### Defined in -[services/customer.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L27) +[packages/medusa/src/services/customer.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L26) ___ @@ -74,7 +84,7 @@ ___ #### Defined in -[services/customer.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L29) +[packages/medusa/src/services/customer.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L28) ___ @@ -88,7 +98,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/customer.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L31) +[packages/medusa/src/services/customer.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L30) ___ @@ -102,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/customer.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L32) +[packages/medusa/src/services/customer.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L31) ___ @@ -120,7 +130,7 @@ ___ #### Defined in -[services/customer.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L34) +[packages/medusa/src/services/customer.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L33) ## Methods @@ -141,7 +151,7 @@ ___ #### Defined in -[services/customer.ts:471](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L471) +[packages/medusa/src/services/customer.ts:461](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L461) ___ @@ -149,6 +159,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -160,21 +174,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -182,13 +198,17 @@ ___ ▸ **count**(): `Promise`<`number`\> +Return the total number of documents in database + #### Returns `Promise`<`number`\> +the result of the count operation + #### Defined in -[services/customer.ts:161](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L161) +[packages/medusa/src/services/customer.ts:158](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L158) ___ @@ -196,19 +216,26 @@ ___ ▸ **create**(`customer`): `Promise`<`Customer`\> +Creates a customer from an email - customers can have accounts associated, +e.g. to login and view order history, etc. If a password is provided the +customer will automatically get an account, otherwise the customer is just +used to hold details of customers. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `customer` | `CreateCustomerInput` | | +| `customer` | `CreateCustomerInput` | the customer to create | #### Returns `Promise`<`Customer`\> +the result of create + #### Defined in -[services/customer.ts:255](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L255) +[packages/medusa/src/services/customer.ts:245](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L245) ___ @@ -216,19 +243,23 @@ ___ ▸ **delete**(`customerId`): `Promise`<`void` \| `Customer`\> +Deletes a customer from a given customer id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `customerId` | `string` | | +| `customerId` | `string` | the id of the customer to delete. Must be castable as an ObjectId | #### Returns `Promise`<`void` \| `Customer`\> +the result of the delete operation. + #### Defined in -[services/customer.ts:519](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L519) +[packages/medusa/src/services/customer.ts:509](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L509) ___ @@ -236,19 +267,27 @@ ___ ▸ **generateResetPasswordToken**(`customerId`): `Promise`<`string`\> +Generate a JSON Web token, that will be sent to a customer, that wishes to +reset password. +The token will be signed with the customer's current password hash as a +secret a long side a payload with userId and the expiry time for the token, +which is always 15 minutes. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `customerId` | `string` | | +| `customerId` | `string` | the customer to reset the password for | #### Returns `Promise`<`string`\> +the generated JSON web token + #### Defined in -[services/customer.ts:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L65) +[packages/medusa/src/services/customer.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L64) ___ @@ -256,19 +295,23 @@ ___ ▸ **hashPassword_**(`password`): `Promise`<`string`\> +Hashes a password + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `password` | `string` | | +| `password` | `string` | the value to hash | #### Returns `Promise`<`string`\> +hashed password + #### Defined in -[services/customer.ts:242](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L242) +[packages/medusa/src/services/customer.ts:232](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L232) ___ @@ -280,16 +323,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | | -| `config` | `FindConfig`<`Customer`\> | | +| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | the query object for find | +| `config` | `FindConfig`<`Customer`\> | the config object containing query settings | #### Returns `Promise`<`Customer`[]\> +the result of the find operation + #### Defined in -[services/customer.ts:108](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L108) +[packages/medusa/src/services/customer.ts:107](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L107) ___ @@ -301,16 +346,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | | -| `config` | `FindConfig`<`Customer`\> | | +| `selector` | `Selector`<`Customer`\> & { `q?`: `string` } | the query object for find | +| `config` | `FindConfig`<`Customer`\> | the config object containing query settings | #### Returns `Promise`<[`Customer`[], `number`]\> +the result of the find operation + #### Defined in -[services/customer.ts:133](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L133) +[packages/medusa/src/services/customer.ts:131](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L131) ___ @@ -331,7 +378,7 @@ ___ #### Defined in -[services/customer.ts:454](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L454) +[packages/medusa/src/services/customer.ts:444](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L444) ___ @@ -339,20 +386,24 @@ ___ ▸ **retrieve**(`customerId`, `config?`): `Promise`<`Customer`\> +Gets a customer by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `customerId` | `string` | | -| `config` | `FindConfig`<`Customer`\> | | +| `customerId` | `string` | the id of the customer to get. | +| `config` | `FindConfig`<`Customer`\> | the config object containing query settings | #### Returns `Promise`<`Customer`\> +the customer document. + #### Defined in -[services/customer.ts:228](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L228) +[packages/medusa/src/services/customer.ts:220](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L220) ___ @@ -360,20 +411,24 @@ ___ ▸ **retrieveByEmail**(`email`, `config?`): `Promise`<`Customer`\> +Gets a customer by email. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `email` | `string` | | -| `config` | `FindConfig`<`Customer`\> | | +| `email` | `string` | the email of the customer to get. | +| `config` | `FindConfig`<`Customer`\> | the config object containing query settings | #### Returns `Promise`<`Customer`\> +the customer document. + #### Defined in -[services/customer.ts:198](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L198) +[packages/medusa/src/services/customer.ts:194](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L194) ___ @@ -381,20 +436,24 @@ ___ ▸ **retrieveByPhone**(`phone`, `config?`): `Promise`<`Customer`\> +Gets a customer by phone. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `phone` | `string` | | -| `config` | `FindConfig`<`Customer`\> | | +| `phone` | `string` | the phone of the customer to get. | +| `config` | `FindConfig`<`Customer`\> | the config object containing query settings | #### Returns `Promise`<`Customer`\> +the customer document. + #### Defined in -[services/customer.ts:213](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L213) +[packages/medusa/src/services/customer.ts:207](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L207) ___ @@ -415,7 +474,7 @@ ___ #### Defined in -[services/customer.ts:168](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L168) +[packages/medusa/src/services/customer.ts:164](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L164) ___ @@ -439,7 +498,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -447,20 +506,24 @@ ___ ▸ **update**(`customerId`, `update`): `Promise`<`Customer`\> +Updates a customer. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `customerId` | `string` | | -| `update` | `UpdateCustomerInput` | | +| `customerId` | `string` | the id of the variant. Must be a string that can be casted to an ObjectId | +| `update` | `UpdateCustomerInput` | an object with the update values. | #### Returns `Promise`<`Customer`\> +resolves to the update result. + #### Defined in -[services/customer.ts:310](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L310) +[packages/medusa/src/services/customer.ts:300](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L300) ___ @@ -482,7 +545,7 @@ ___ #### Defined in -[services/customer.ts:426](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L426) +[packages/medusa/src/services/customer.ts:416](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L416) ___ @@ -490,20 +553,24 @@ ___ ▸ **updateBillingAddress_**(`customer`, `addressOrId`): `Promise`<`void`\> +Updates the customers' billing address. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `customer` | `Customer` | | -| `addressOrId` | `undefined` \| `string` \| { `address_1?`: ``null`` \| `string` ; `address_2?`: ``null`` \| `string` ; `city?`: ``null`` \| `string` ; `company?`: ``null`` \| `string` ; `country?`: ``null`` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; } ; `country_code?`: ``null`` \| `string` ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `customer?`: ``null`` \| { email?: string \| undefined; first\_name?: string \| undefined; last\_name?: string \| undefined; billing\_address\_id?: string \| null \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 10 more ...; updated\_at?: { ...; } \| undef... ; `customer_id?`: ``null`` \| `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `first_name?`: ``null`` \| `string` ; `id?`: `string` ; `last_name?`: ``null`` \| `string` ; `metadata?`: { [x: string]: unknown; } ; `phone?`: ``null`` \| `string` ; `postal_code?`: ``null`` \| `string` ; `province?`: ``null`` \| `string` ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } } | | +| `customer` | `Customer` | the Customer to update | +| `addressOrId` | `undefined` \| `string` \| { `address_1?`: ``null`` \| `string` ; `address_2?`: ``null`` \| `string` ; `city?`: ``null`` \| `string` ; `company?`: ``null`` \| `string` ; `country?`: ``null`` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; } ; `country_code?`: ``null`` \| `string` ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `customer?`: ``null`` \| { email?: string \| undefined; first\_name?: string \| undefined; last\_name?: string \| undefined; billing\_address\_id?: string \| null \| undefined; billing\_address?: { customer\_id?: string \| null \| undefined; ... 16 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 10 more ...; updated\_at?: { ...; } \| undef... ; `customer_id?`: ``null`` \| `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `first_name?`: ``null`` \| `string` ; `id?`: `string` ; `last_name?`: ``null`` \| `string` ; `metadata?`: { [x: string]: unknown; } ; `phone?`: ``null`` \| `string` ; `postal_code?`: ``null`` \| `string` ; `province?`: ``null`` \| `string` ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } } | the value to set the billing address to | #### Returns `Promise`<`void`\> +the result of the update operation + #### Defined in -[services/customer.ts:374](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/customer.ts#L374) +[packages/medusa/src/services/customer.ts:364](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/customer.ts#L364) ___ @@ -527,4 +594,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/DiscountService.md b/docs/content/references/services/classes/DiscountService.md index d22ef85e7f..7192fa369b 100644 --- a/docs/content/references/services/classes/DiscountService.md +++ b/docs/content/references/services/classes/DiscountService.md @@ -1,5 +1,9 @@ # Class: DiscountService +Provides layer to manipulate discounts. + +**`Implements`** + ## Hierarchy - `TransactionBaseService`<[`DiscountService`](DiscountService.md)\> @@ -24,7 +28,7 @@ TransactionBaseService<DiscountService\>.constructor #### Defined in -[services/discount.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L62) +[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L62) ## Properties @@ -36,6 +40,10 @@ TransactionBaseService<DiscountService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +54,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### customerService\_ @@ -54,7 +66,7 @@ ___ #### Defined in -[services/discount.ts:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L52) +[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L52) ___ @@ -64,7 +76,7 @@ ___ #### Defined in -[services/discount.ts:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L55) +[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L55) ___ @@ -74,7 +86,7 @@ ___ #### Defined in -[services/discount.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L56) +[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L56) ___ @@ -84,7 +96,7 @@ ___ #### Defined in -[services/discount.ts:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L51) +[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L51) ___ @@ -94,7 +106,7 @@ ___ #### Defined in -[services/discount.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L53) +[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L53) ___ @@ -104,7 +116,7 @@ ___ #### Defined in -[services/discount.ts:60](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L60) +[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L60) ___ @@ -114,7 +126,7 @@ ___ #### Defined in -[services/discount.ts:54](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L54) +[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L54) ___ @@ -128,7 +140,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/discount.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L48) +[packages/medusa/src/services/discount.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L48) ___ @@ -138,7 +150,7 @@ ___ #### Defined in -[services/discount.ts:58](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L58) +[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L58) ___ @@ -148,7 +160,7 @@ ___ #### Defined in -[services/discount.ts:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L59) +[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L59) ___ @@ -158,7 +170,7 @@ ___ #### Defined in -[services/discount.ts:57](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L57) +[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L57) ___ @@ -172,7 +184,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/discount.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L49) +[packages/medusa/src/services/discount.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L49) ## Methods @@ -180,20 +192,24 @@ TransactionBaseService.transactionManager\_ ▸ **addRegion**(`discountId`, `regionId`): `Promise`<`Discount`\> +Adds a region to the discount regions array. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discountId` | `string` | | -| `regionId` | `string` | | +| `discountId` | `string` | id of discount | +| `regionId` | `string` | id of region to add | #### Returns `Promise`<`Discount`\> +the result of the update operation + #### Defined in -[services/discount.ts:477](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L477) +[packages/medusa/src/services/discount.ts:465](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L465) ___ @@ -201,6 +217,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -212,21 +232,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -248,7 +270,7 @@ ___ #### Defined in -[services/discount.ts:576](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L576) +[packages/medusa/src/services/discount.ts:566](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L566) ___ @@ -269,7 +291,7 @@ ___ #### Defined in -[services/discount.ts:720](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L720) +[packages/medusa/src/services/discount.ts:710](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L710) ___ @@ -277,19 +299,24 @@ ___ ▸ **create**(`discount`): `Promise`<`Discount`\> +Creates a discount with provided data given that the data is validated. +Normalizes discount code to uppercase. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discount` | `CreateDiscountInput` | | +| `discount` | `CreateDiscountInput` | the discount data to create | #### Returns `Promise`<`Discount`\> +the result of the create operation + #### Defined in -[services/discount.ts:182](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L182) +[packages/medusa/src/services/discount.ts:176](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L176) ___ @@ -297,20 +324,24 @@ ___ ▸ **createDynamicCode**(`discountId`, `data`): `Promise`<`Discount`\> +Creates a dynamic code for a discount id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discountId` | `string` | | -| `data` | `CreateDynamicDiscountInput` | | +| `discountId` | `string` | the id of the discount to create a code for | +| `data` | `CreateDynamicDiscountInput` | the object containing a code to identify the discount by | #### Returns `Promise`<`Discount`\> +the newly created dynamic code + #### Defined in -[services/discount.ts:405](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L405) +[packages/medusa/src/services/discount.ts:393](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L393) ___ @@ -318,19 +349,23 @@ ___ ▸ **delete**(`discountId`): `Promise`<`void`\> +Deletes a discount idempotently + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discountId` | `string` | | +| `discountId` | `string` | id of discount to delete | #### Returns `Promise`<`void`\> +the result of the delete operation + #### Defined in -[services/discount.ts:537](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L537) +[packages/medusa/src/services/discount.ts:525](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L525) ___ @@ -338,20 +373,24 @@ ___ ▸ **deleteDynamicCode**(`discountId`, `code`): `Promise`<`void`\> +Deletes a dynamic code for a discount id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discountId` | `string` | | -| `code` | `string` | | +| `discountId` | `string` | the id of the discount to create a code for | +| `code` | `string` | the code to identify the discount by | #### Returns `Promise`<`void`\> +the newly created dynamic code + #### Defined in -[services/discount.ts:456](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L456) +[packages/medusa/src/services/discount.ts:444](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L444) ___ @@ -371,7 +410,7 @@ ___ #### Defined in -[services/discount.ts:689](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L689) +[packages/medusa/src/services/discount.ts:679](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L679) ___ @@ -391,7 +430,7 @@ ___ #### Defined in -[services/discount.ts:685](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L685) +[packages/medusa/src/services/discount.ts:675](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L675) ___ @@ -411,7 +450,7 @@ ___ #### Defined in -[services/discount.ts:679](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L679) +[packages/medusa/src/services/discount.ts:669](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L669) ___ @@ -431,7 +470,7 @@ ___ #### Defined in -[services/discount.ts:697](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L697) +[packages/medusa/src/services/discount.ts:687](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L687) ___ @@ -452,7 +491,7 @@ ___ #### Defined in -[services/discount.ts:701](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L701) +[packages/medusa/src/services/discount.ts:691](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L691) ___ @@ -464,16 +503,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableDiscountProps` | | -| `config` | `FindConfig`<`Discount`\> | | +| `selector` | `FilterableDiscountProps` | the query object for find | +| `config` | `FindConfig`<`Discount`\> | the config object containing query settings | #### Returns `Promise`<`Discount`[]\> +the result of the find operation + #### Defined in -[services/discount.ts:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L114) +[packages/medusa/src/services/discount.ts:114](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L114) ___ @@ -485,16 +526,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableDiscountProps` | | -| `config` | `FindConfig`<`Discount`\> | | +| `selector` | `FilterableDiscountProps` | the query object for find | +| `config` | `FindConfig`<`Discount`\> | the config object containing query settings | #### Returns `Promise`<[`Discount`[], `number`]\> +the result of the find operation + #### Defined in -[services/discount.ts:133](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L133) +[packages/medusa/src/services/discount.ts:130](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L130) ___ @@ -502,20 +545,24 @@ ___ ▸ **removeRegion**(`discountId`, `regionId`): `Promise`<`Discount`\> +Removes a region from the discount regions array. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discountId` | `string` | | -| `regionId` | `string` | | +| `discountId` | `string` | id of discount | +| `regionId` | `string` | id of region to remove | #### Returns `Promise`<`Discount`\> +the result of the update operation + #### Defined in -[services/discount.ts:512](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L512) +[packages/medusa/src/services/discount.ts:500](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L500) ___ @@ -523,20 +570,24 @@ ___ ▸ **retrieve**(`discountId`, `config?`): `Promise`<`Discount`\> +Gets a discount by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discountId` | `string` | | -| `config` | `FindConfig`<`Discount`\> | | +| `discountId` | `string` | id of discount to retrieve | +| `config` | `FindConfig`<`Discount`\> | the config object containing query settings | #### Returns `Promise`<`Discount`\> +the discount + #### Defined in -[services/discount.ts:247](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L247) +[packages/medusa/src/services/discount.ts:241](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L241) ___ @@ -544,20 +595,24 @@ ___ ▸ **retrieveByCode**(`discountCode`, `config?`): `Promise`<`Discount`\> +Gets a discount by discount code. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discountCode` | `string` | | -| `config` | `FindConfig`<`Discount`\> | | +| `discountCode` | `string` | discount code of discount to retrieve | +| `config` | `FindConfig`<`Discount`\> | the config object containing query settings | #### Returns `Promise`<`Discount`\> +the discount document + #### Defined in -[services/discount.ts:276](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L276) +[packages/medusa/src/services/discount.ts:267](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L267) ___ @@ -581,7 +636,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -589,20 +644,24 @@ ___ ▸ **update**(`discountId`, `update`): `Promise`<`Discount`\> +Updates a discount. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discountId` | `string` | | -| `update` | `UpdateDiscountInput` | | +| `discountId` | `string` | discount id of discount to update | +| `update` | `UpdateDiscountInput` | the data to update the discount with | #### Returns `Promise`<`Discount`\> +the result of the update operation + #### Defined in -[services/discount.ts:310](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L310) +[packages/medusa/src/services/discount.ts:298](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L298) ___ @@ -623,7 +682,7 @@ ___ #### Defined in -[services/discount.ts:619](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L619) +[packages/medusa/src/services/discount.ts:609](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L609) ___ @@ -644,7 +703,7 @@ ___ #### Defined in -[services/discount.ts:551](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L551) +[packages/medusa/src/services/discount.ts:539](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L539) ___ @@ -652,6 +711,8 @@ ___ ▸ **validateDiscountRule_**<`T`\>(`discountRule`): `T` +Creates a discount rule with provided data given that the data is validated. + #### Type parameters | Name | Type | @@ -662,15 +723,17 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `discountRule` | `T` | | +| `discountRule` | `T` | the discount rule to create | #### Returns `T` +the result of the create operation + #### Defined in -[services/discount.ts:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L96) +[packages/medusa/src/services/discount.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/discount.ts#L96) ___ @@ -694,4 +757,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/DraftOrderService.md b/docs/content/references/services/classes/DraftOrderService.md index 93ead15e07..952acbf311 100644 --- a/docs/content/references/services/classes/DraftOrderService.md +++ b/docs/content/references/services/classes/DraftOrderService.md @@ -1,5 +1,9 @@ # Class: DraftOrderService +Handles draft orders + +**`Implements`** + ## Hierarchy - `TransactionBaseService`<[`DraftOrderService`](DraftOrderService.md)\> @@ -24,7 +28,7 @@ TransactionBaseService<DraftOrderService\>.constructor #### Defined in -[services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L51) +[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L51) ## Properties @@ -34,7 +38,7 @@ TransactionBaseService<DraftOrderService\>.constructor #### Defined in -[services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L46) +[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L46) ___ @@ -46,6 +50,10 @@ ___ TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -56,6 +64,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### draftOrderRepository\_ @@ -64,7 +76,7 @@ ___ #### Defined in -[services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L42) +[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L42) ___ @@ -74,7 +86,7 @@ ___ #### Defined in -[services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L45) +[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L45) ___ @@ -84,7 +96,7 @@ ___ #### Defined in -[services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L47) +[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L47) ___ @@ -98,7 +110,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L39) +[packages/medusa/src/services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L39) ___ @@ -108,7 +120,7 @@ ___ #### Defined in -[services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L44) +[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L44) ___ @@ -118,7 +130,7 @@ ___ #### Defined in -[services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L43) +[packages/medusa/src/services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L43) ___ @@ -128,7 +140,7 @@ ___ #### Defined in -[services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L48) +[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L48) ___ @@ -138,7 +150,7 @@ ___ #### Defined in -[services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L49) +[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L49) ___ @@ -152,7 +164,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L40) +[packages/medusa/src/services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L40) ___ @@ -169,7 +181,7 @@ ___ #### Defined in -[services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L34) +[packages/medusa/src/services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L34) ## Methods @@ -177,6 +189,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -188,21 +204,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -210,19 +228,23 @@ ___ ▸ **create**(`data`): `Promise`<`DraftOrder`\> +Creates a draft order. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `AdminPostDraftOrdersReq` | | +| `data` | `AdminPostDraftOrdersReq` | data to create draft order from | #### Returns `Promise`<`DraftOrder`\> +the created draft order + #### Defined in -[services/draft-order.ts:257](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L257) +[packages/medusa/src/services/draft-order.ts:245](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L245) ___ @@ -230,19 +252,23 @@ ___ ▸ **delete**(`draftOrderId`): `Promise`<`undefined` \| `DraftOrder`\> +Deletes draft order idempotently. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `draftOrderId` | `string` | | +| `draftOrderId` | `string` | id of draft order to delete | #### Returns `Promise`<`undefined` \| `DraftOrder`\> +empty promise + #### Defined in -[services/draft-order.ts:150](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L150) +[packages/medusa/src/services/draft-order.ts:144](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L144) ___ @@ -250,20 +276,24 @@ ___ ▸ **list**(`selector`, `config?`): `Promise`<`DraftOrder`[]\> +Lists draft orders + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `FindConfig`<`DraftOrder`\> | | +| `selector` | `any` | query object for find | +| `config` | `FindConfig`<`DraftOrder`\> | configurable attributes for find | #### Returns `Promise`<`DraftOrder`[]\> +list of draft orders + #### Defined in -[services/draft-order.ts:231](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L231) +[packages/medusa/src/services/draft-order.ts:222](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L222) ___ @@ -271,20 +301,24 @@ ___ ▸ **listAndCount**(`selector`, `config?`): `Promise`<[`DraftOrder`[], `number`]\> +Lists draft orders alongside the count + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `FindConfig`<`DraftOrder`\> | | +| `selector` | `any` | query selector to filter draft orders | +| `config` | `FindConfig`<`DraftOrder`\> | query config | #### Returns `Promise`<[`DraftOrder`[], `number`]\> +draft orders + #### Defined in -[services/draft-order.ts:174](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L174) +[packages/medusa/src/services/draft-order.ts:168](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L168) ___ @@ -292,20 +326,24 @@ ___ ▸ **registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\> +Registers a draft order as completed, when an order has been completed. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `draftOrderId` | `string` | | -| `orderId` | `string` | | +| `draftOrderId` | `string` | id of draft order to complete | +| `orderId` | `string` | id of order completed from draft order cart | #### Returns `Promise`<`UpdateResult`\> +the created order + #### Defined in -[services/draft-order.ts:363](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L363) +[packages/medusa/src/services/draft-order.ts:351](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L351) ___ @@ -313,20 +351,24 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`DraftOrder`\> +Retrieves a draft order with the given id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `FindConfig`<`DraftOrder`\> | | +| `id` | `string` | id of the draft order to retrieve | +| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne | #### Returns `Promise`<`DraftOrder`\> +the draft order + #### Defined in -[services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L91) +[packages/medusa/src/services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L91) ___ @@ -334,20 +376,24 @@ ___ ▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<`DraftOrder`\> +Retrieves a draft order based on its associated cart id + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `config` | `FindConfig`<`DraftOrder`\> | | +| `cartId` | `string` | cart id that the draft orders's cart has | +| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne | #### Returns `Promise`<`DraftOrder`\> +the draft order + #### Defined in -[services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L121) +[packages/medusa/src/services/draft-order.ts:118](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L118) ___ @@ -371,7 +417,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -379,21 +425,25 @@ ___ ▸ **update**(`id`, `data`): `Promise`<`DraftOrder`\> +Updates a draft order with the given data + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `data` | `Object` | | +| `id` | `string` | id of the draft order | +| `data` | `Object` | values to update the order with | | `data.no_notification_order` | `boolean` | - | #### Returns `Promise`<`DraftOrder`\> +the updated draft order + #### Defined in -[services/draft-order.ts:392](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L392) +[packages/medusa/src/services/draft-order.ts:380](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L380) ___ @@ -417,4 +467,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/EventBusService.md b/docs/content/references/services/classes/EventBusService.md index 2d7ce24b3e..04cc37cd9d 100644 --- a/docs/content/references/services/classes/EventBusService.md +++ b/docs/content/references/services/classes/EventBusService.md @@ -1,5 +1,8 @@ # Class: EventBusService +Can keep track of multiple subscribers to different events and run the +subscribers when events happen. Events will run asynchronously. + ## Constructors ### constructor @@ -16,7 +19,7 @@ #### Defined in -[services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L38) +[packages/medusa/src/services/event-bus.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L38) ## Properties @@ -26,7 +29,7 @@ #### Defined in -[services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L24) +[packages/medusa/src/services/event-bus.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L24) ___ @@ -36,7 +39,7 @@ ___ #### Defined in -[services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L29) +[packages/medusa/src/services/event-bus.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L29) ___ @@ -46,7 +49,7 @@ ___ #### Defined in -[services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L32) +[packages/medusa/src/services/event-bus.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L32) ___ @@ -56,7 +59,7 @@ ___ #### Defined in -[services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L36) +[packages/medusa/src/services/event-bus.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L36) ___ @@ -66,7 +69,7 @@ ___ #### Defined in -[services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L26) +[packages/medusa/src/services/event-bus.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L26) ___ @@ -76,7 +79,7 @@ ___ #### Defined in -[services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L25) +[packages/medusa/src/services/event-bus.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L25) ___ @@ -86,7 +89,7 @@ ___ #### Defined in -[services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L28) +[packages/medusa/src/services/event-bus.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L28) ___ @@ -96,7 +99,7 @@ ___ #### Defined in -[services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L33) +[packages/medusa/src/services/event-bus.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L33) ___ @@ -106,7 +109,7 @@ ___ #### Defined in -[services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L30) +[packages/medusa/src/services/event-bus.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L30) ___ @@ -116,7 +119,7 @@ ___ #### Defined in -[services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L31) +[packages/medusa/src/services/event-bus.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L31) ___ @@ -126,7 +129,7 @@ ___ #### Defined in -[services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L34) +[packages/medusa/src/services/event-bus.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L34) ___ @@ -136,7 +139,7 @@ ___ #### Defined in -[services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L27) +[packages/medusa/src/services/event-bus.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L27) ___ @@ -146,7 +149,7 @@ ___ #### Defined in -[services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L35) +[packages/medusa/src/services/event-bus.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L35) ## Methods @@ -154,6 +157,8 @@ ___ ▸ **createCronJob**<`T`\>(`eventName`, `data`, `cron`, `handler`): `void` +Registers a cron job. + #### Type parameters | Name | @@ -164,18 +169,20 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `eventName` | `string` | | -| `data` | `T` | | -| `cron` | `string` | | -| `handler` | `Subscriber`<`unknown`\> | | +| `eventName` | `string` | the name of the event | +| `data` | `T` | the data to be sent with the event | +| `cron` | `string` | the cron pattern | +| `handler` | `Subscriber`<`unknown`\> | the handler to call on each cron job | #### Returns `void` +void + #### Defined in -[services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L308) +[packages/medusa/src/services/event-bus.ts:308](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L308) ___ @@ -183,6 +190,8 @@ ___ ▸ **cronWorker_**<`T`\>(`job`): `Promise`<`unknown`[]\> +Handles incoming jobs. + #### Type parameters | Name | @@ -193,7 +202,7 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `job` | `Object` | | +| `job` | `Object` | The job object | | `job.data` | `Object` | - | | `job.data.data` | `T` | - | | `job.data.eventName` | `string` | - | @@ -202,9 +211,11 @@ ___ `Promise`<`unknown`[]\> +resolves to the results of the subscriber calls. + #### Defined in -[services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L281) +[packages/medusa/src/services/event-bus.ts:281](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L281) ___ @@ -212,6 +223,8 @@ ___ ▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| `StagedJob`\> +Calls all subscribers when an event occurs. + #### Type parameters | Name | @@ -222,18 +235,20 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `eventName` | `string` | | -| `data` | `T` | | -| `options` | `Object` | | +| `eventName` | `string` | the name of the event to be process. | +| `data` | `T` | the data to send to the subscriber. | +| `options` | `Object` | options to add the job with | | `options.delay?` | `number` | - | #### Returns `Promise`<`void` \| `StagedJob`\> +the job from our queue + #### Defined in -[services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L179) +[packages/medusa/src/services/event-bus.ts:179](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L179) ___ @@ -247,7 +262,7 @@ ___ #### Defined in -[services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L215) +[packages/medusa/src/services/event-bus.ts:215](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L215) ___ @@ -255,20 +270,24 @@ ___ ▸ `Protected` **registerCronHandler_**(`event`, `subscriber`): [`EventBusService`](EventBusService.md) +Adds a function to a list of event subscribers. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `event` | `string` \| `symbol` | | -| `subscriber` | `Subscriber`<`unknown`\> | | +| `event` | `string` \| `symbol` | the event that the subscriber will listen for. | +| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. | #### Returns [`EventBusService`](EventBusService.md) +this + #### Defined in -[services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L158) +[packages/medusa/src/services/event-bus.ts:158](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L158) ___ @@ -282,7 +301,7 @@ ___ #### Defined in -[services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L205) +[packages/medusa/src/services/event-bus.ts:205](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L205) ___ @@ -296,7 +315,7 @@ ___ #### Defined in -[services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L210) +[packages/medusa/src/services/event-bus.ts:210](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L210) ___ @@ -304,20 +323,24 @@ ___ ▸ **subscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md) +Adds a function to a list of event subscribers. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `event` | `string` \| `symbol` | | -| `subscriber` | `Subscriber`<`unknown`\> | | +| `event` | `string` \| `symbol` | the event that the subscriber will listen for. | +| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. | #### Returns [`EventBusService`](EventBusService.md) +this + #### Defined in -[services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L118) +[packages/medusa/src/services/event-bus.ts:118](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L118) ___ @@ -325,20 +348,24 @@ ___ ▸ **unsubscribe**(`event`, `subscriber`): [`EventBusService`](EventBusService.md) +Adds a function to a list of event subscribers. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `event` | `string` \| `symbol` | | -| `subscriber` | `Subscriber`<`unknown`\> | | +| `event` | `string` \| `symbol` | the event that the subscriber will listen for. | +| `subscriber` | `Subscriber`<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. | #### Returns [`EventBusService`](EventBusService.md) +this + #### Defined in -[services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L136) +[packages/medusa/src/services/event-bus.ts:136](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L136) ___ @@ -358,7 +385,7 @@ ___ #### Defined in -[services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L88) +[packages/medusa/src/services/event-bus.ts:88](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L88) ___ @@ -366,6 +393,8 @@ ___ ▸ **worker_**<`T`\>(`job`): `Promise`<`unknown`[]\> +Handles incoming jobs. + #### Type parameters | Name | @@ -376,7 +405,7 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `job` | `Object` | | +| `job` | `Object` | The job object | | `job.data` | `Object` | - | | `job.data.data` | `T` | - | | `job.data.eventName` | `string` | - | @@ -385,6 +414,8 @@ ___ `Promise`<`unknown`[]\> +resolves to the results of the subscriber calls. + #### Defined in -[services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/event-bus.ts#L250) +[packages/medusa/src/services/event-bus.ts:250](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/event-bus.ts#L250) diff --git a/docs/content/references/services/classes/FulfillmentProviderService.md b/docs/content/references/services/classes/FulfillmentProviderService.md index 471233ed75..d31f7a4c15 100644 --- a/docs/content/references/services/classes/FulfillmentProviderService.md +++ b/docs/content/references/services/classes/FulfillmentProviderService.md @@ -1,5 +1,7 @@ # Class: FulfillmentProviderService +Helps retrive fulfillment providers + ## Constructors ### constructor @@ -14,7 +16,7 @@ #### Defined in -[services/fulfillment-provider.js:7](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L7) +[packages/medusa/src/services/fulfillment-provider.js:7](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L7) ## Methods @@ -36,7 +38,7 @@ #### Defined in -[services/fulfillment-provider.js:79](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L79) +[packages/medusa/src/services/fulfillment-provider.js:79](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L79) ___ @@ -56,7 +58,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:64](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L64) +[packages/medusa/src/services/fulfillment-provider.js:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L64) ___ @@ -76,7 +78,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:74](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L74) +[packages/medusa/src/services/fulfillment-provider.js:74](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L74) ___ @@ -99,7 +101,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L59) +[packages/medusa/src/services/fulfillment-provider.js:59](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L59) ___ @@ -119,7 +121,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L89) +[packages/medusa/src/services/fulfillment-provider.js:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L89) ___ @@ -133,7 +135,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L23) +[packages/medusa/src/services/fulfillment-provider.js:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L23) ___ @@ -153,7 +155,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L30) +[packages/medusa/src/services/fulfillment-provider.js:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L30) ___ @@ -173,7 +175,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:12](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L12) +[packages/medusa/src/services/fulfillment-provider.js:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L12) ___ @@ -181,13 +183,15 @@ ___ ▸ **retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\> +Fetches documents from the fulfillment provider + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `providerId` | `string` | | -| `fulfillmentData` | `any` | | -| `documentType` | ``"label"`` \| ``"invoice"`` | | +| `providerId` | `string` | the id of the provider | +| `fulfillmentData` | `any` | the data relating to the fulfillment | +| `documentType` | ``"label"`` \| ``"invoice"`` | the typ of document to fetch | #### Returns @@ -195,7 +199,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L102) +[packages/medusa/src/services/fulfillment-provider.js:102](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L102) ___ @@ -207,15 +211,17 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `provider_id` | `string` | | +| `provider_id` | `string` | the provider id | #### Returns `FulfillmentService` +the payment fulfillment provider + #### Defined in -[services/fulfillment-provider.js:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L48) +[packages/medusa/src/services/fulfillment-provider.js:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L48) ___ @@ -237,7 +243,7 @@ ___ #### Defined in -[services/fulfillment-provider.js:69](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L69) +[packages/medusa/src/services/fulfillment-provider.js:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L69) ___ @@ -257,4 +263,4 @@ ___ #### Defined in -[services/fulfillment-provider.js:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment-provider.js#L84) +[packages/medusa/src/services/fulfillment-provider.js:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment-provider.js#L84) diff --git a/docs/content/references/services/classes/FulfillmentService.md b/docs/content/references/services/classes/FulfillmentService.md index 7865950d85..695e307263 100644 --- a/docs/content/references/services/classes/FulfillmentService.md +++ b/docs/content/references/services/classes/FulfillmentService.md @@ -1,5 +1,7 @@ # Class: FulfillmentService +Handles Fulfillments + ## Hierarchy - `TransactionBaseService`<[`FulfillmentService`](FulfillmentService.md)\> @@ -24,7 +26,7 @@ TransactionBaseService<FulfillmentService\>.constructor #### Defined in -[services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L47) +[packages/medusa/src/services/fulfillment.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L47) ## Properties @@ -36,6 +38,10 @@ TransactionBaseService<FulfillmentService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +52,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### fulfillmentProviderService\_ @@ -54,7 +64,7 @@ ___ #### Defined in -[services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L42) +[packages/medusa/src/services/fulfillment.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L42) ___ @@ -64,7 +74,7 @@ ___ #### Defined in -[services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L43) +[packages/medusa/src/services/fulfillment.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L43) ___ @@ -74,7 +84,7 @@ ___ #### Defined in -[services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L45) +[packages/medusa/src/services/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L45) ___ @@ -84,7 +94,7 @@ ___ #### Defined in -[services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L40) +[packages/medusa/src/services/fulfillment.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L40) ___ @@ -98,7 +108,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L36) +[packages/medusa/src/services/fulfillment.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L36) ___ @@ -108,7 +118,7 @@ ___ #### Defined in -[services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L41) +[packages/medusa/src/services/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L41) ___ @@ -118,7 +128,7 @@ ___ #### Defined in -[services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L39) +[packages/medusa/src/services/fulfillment.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L39) ___ @@ -128,7 +138,7 @@ ___ #### Defined in -[services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L44) +[packages/medusa/src/services/fulfillment.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L44) ___ @@ -142,7 +152,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L37) +[packages/medusa/src/services/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L37) ## Methods @@ -150,6 +160,10 @@ TransactionBaseService.transactionManager\_ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -161,21 +175,23 @@ TransactionBaseService.transactionManager\_ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -183,19 +199,25 @@ ___ ▸ **cancelFulfillment**(`fulfillmentOrId`): `Promise`<`Fulfillment`\> +Cancels a fulfillment with the fulfillment provider. Will decrement the +fulfillment_quantity on the line items associated with the fulfillment. +Throws if the fulfillment has already been shipped. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `fulfillmentOrId` | `string` \| `Fulfillment` | | +| `fulfillmentOrId` | `string` \| `Fulfillment` | the fulfillment object or id. | #### Returns `Promise`<`Fulfillment`\> +the result of the save operation + #### Defined in -[services/fulfillment.ts:254](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L254) +[packages/medusa/src/services/fulfillment.ts:253](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L253) ___ @@ -203,43 +225,55 @@ ___ ▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<`Fulfillment`[]\> +Creates an order fulfillment +If items needs to be fulfilled by different provider, we make +sure to partition those items, and create fulfillment for +those partitions. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `CreateFulfillmentOrder` | | -| `itemsToFulfill` | `FulFillmentItemType`[] | | -| `custom` | `Partial`<`Fulfillment`\> | | +| `order` | `CreateFulfillmentOrder` | order to create fulfillment for | +| `itemsToFulfill` | `FulFillmentItemType`[] | the items in the order to fulfill | +| `custom` | `Partial`<`Fulfillment`\> | potential custom values to add | #### Returns `Promise`<`Fulfillment`[]\> +the created fulfillments + #### Defined in -[services/fulfillment.ts:199](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L199) +[packages/medusa/src/services/fulfillment.ts:198](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L198) ___ ### createShipment -▸ **createShipment**(`fulfillmentId`, `trackingLinks`, `config?`): `Promise`<`Fulfillment`\> +▸ **createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<`Fulfillment`\> + +Creates a shipment by marking a fulfillment as shipped. Adds +tracking links and potentially more metadata. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `fulfillmentId` | `string` | | -| `trackingLinks` | { `tracking_number`: `string` }[] | | -| `config` | `CreateShipmentConfig` | | +| `fulfillmentId` | `string` | the fulfillment to ship | +| `trackingLinks?` | { `tracking_number`: `string` }[] | tracking links for the shipment | +| `config` | `CreateShipmentConfig` | potential configuration settings, such as no_notification and metadata | #### Returns `Promise`<`Fulfillment`\> +the shipped fulfillment + #### Defined in -[services/fulfillment.ts:304](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L304) +[packages/medusa/src/services/fulfillment.ts:303](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L303) ___ @@ -247,20 +281,24 @@ ___ ▸ **getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| `LineItem`)[]\> +Retrieves the order line items, given an array of items. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `CreateFulfillmentOrder` | | -| `items` | `FulFillmentItemType`[] | | +| `order` | `CreateFulfillmentOrder` | the order to get line items from | +| `items` | `FulFillmentItemType`[] | the items to get | #### Returns `Promise`<(``null`` \| `LineItem`)[]\> +the line items generated by the transformer. + #### Defined in -[services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L109) +[packages/medusa/src/services/fulfillment.ts:109](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L109) ___ @@ -281,7 +319,7 @@ ___ #### Defined in -[services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L71) +[packages/medusa/src/services/fulfillment.ts:71](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L71) ___ @@ -289,20 +327,24 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`Fulfillment`\> +Retrieves a fulfillment by its id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `FindConfig`<`Fulfillment`\> | | +| `id` | `string` | the id of the fulfillment to retrieve | +| `config` | `FindConfig`<`Fulfillment`\> | optional values to include with fulfillmentRepository query | #### Returns `Promise`<`Fulfillment`\> +the fulfillment + #### Defined in -[services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L166) +[packages/medusa/src/services/fulfillment.ts:166](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L166) ___ @@ -326,7 +368,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -334,20 +376,28 @@ ___ ▸ **validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| `LineItem` +Checks that a given quantity of a line item can be fulfilled. Fails if the +fulfillable quantity is lower than the requested fulfillment quantity. +Fulfillable quantity is calculated by subtracting the already fulfilled +quantity from the quantity that was originally purchased. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `item` | `undefined` \| `LineItem` | | -| `quantity` | `number` | | +| `item` | `undefined` \| `LineItem` | the line item to check has sufficient fulfillable quantity. | +| `quantity` | `number` | the quantity that is requested to be fulfilled. | #### Returns ``null`` \| `LineItem` +a line item that has the requested fulfillment quantity + set. + #### Defined in -[services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/fulfillment.ts#L134) +[packages/medusa/src/services/fulfillment.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/fulfillment.ts#L134) ___ @@ -371,4 +421,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/GiftCardService.md b/docs/content/references/services/classes/GiftCardService.md index 4e55a21335..a954fb6400 100644 --- a/docs/content/references/services/classes/GiftCardService.md +++ b/docs/content/references/services/classes/GiftCardService.md @@ -1,5 +1,7 @@ # Class: GiftCardService +Provides layer to manipulate gift cards. + ## Hierarchy - `TransactionBaseService`<[`GiftCardService`](GiftCardService.md)\> @@ -24,7 +26,7 @@ TransactionBaseService<GiftCardService\>.constructor #### Defined in -[services/gift-card.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L46) +[packages/medusa/src/services/gift-card.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L46) ## Properties @@ -36,6 +38,10 @@ TransactionBaseService<GiftCardService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +52,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### eventBus\_ @@ -54,7 +64,7 @@ ___ #### Defined in -[services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L37) +[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L37) ___ @@ -64,7 +74,7 @@ ___ #### Defined in -[services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L34) +[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L34) ___ @@ -74,7 +84,7 @@ ___ #### Defined in -[services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L35) +[packages/medusa/src/services/gift-card.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L35) ___ @@ -88,7 +98,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L39) +[packages/medusa/src/services/gift-card.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L39) ___ @@ -98,7 +108,7 @@ ___ #### Defined in -[services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L36) +[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L36) ___ @@ -112,7 +122,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L40) +[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L40) ___ @@ -128,7 +138,7 @@ ___ #### Defined in -[services/gift-card.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L42) +[packages/medusa/src/services/gift-card.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L42) ## Methods @@ -136,6 +146,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -147,21 +161,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -169,19 +185,23 @@ ___ ▸ **create**(`giftCard`): `Promise`<`GiftCard`\> +Creates a gift card with provided data given that the data is validated. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `giftCard` | `CreateGiftCardInput` | | +| `giftCard` | `CreateGiftCardInput` | the gift card data to create | #### Returns `Promise`<`GiftCard`\> +the result of the create operation + #### Defined in -[services/gift-card.ts:155](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L155) +[packages/medusa/src/services/gift-card.ts:152](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L152) ___ @@ -201,7 +221,7 @@ ___ #### Defined in -[services/gift-card.ts:139](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L139) +[packages/medusa/src/services/gift-card.ts:137](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L137) ___ @@ -209,19 +229,23 @@ ___ ▸ **delete**(`giftCardId`): `Promise`<`void` \| `GiftCard`\> +Deletes a gift card idempotently + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `giftCardId` | `string` | | +| `giftCardId` | `string` | id of gift card to delete | #### Returns `Promise`<`void` \| `GiftCard`\> +the result of the delete operation + #### Defined in -[services/gift-card.ts:288](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L288) +[packages/medusa/src/services/gift-card.ts:282](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L282) ___ @@ -233,16 +257,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `QuerySelector`<`GiftCard`\> | | -| `config` | `FindConfig`<`GiftCard`\> | | +| `selector` | `QuerySelector`<`GiftCard`\> | the query object for find | +| `config` | `FindConfig`<`GiftCard`\> | the configuration used to find the objects. contains relations, skip, and take. | #### Returns `Promise`<`GiftCard`[]\> +the result of the find operation + #### Defined in -[services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L114) +[packages/medusa/src/services/gift-card.ts:113](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L113) ___ @@ -254,16 +280,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `QuerySelector`<`GiftCard`\> | | -| `config` | `FindConfig`<`GiftCard`\> | | +| `selector` | `QuerySelector`<`GiftCard`\> | the query object for find | +| `config` | `FindConfig`<`GiftCard`\> | the configuration used to find the objects. contains relations, skip, and take. | #### Returns `Promise`<[`GiftCard`[], `number`]\> +the result of the find operation + #### Defined in -[services/gift-card.ts:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L84) +[packages/medusa/src/services/gift-card.ts:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L84) ___ @@ -271,20 +299,24 @@ ___ ▸ **retrieve**(`giftCardId`, `config?`): `Promise`<`GiftCard`\> +Gets a gift card by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `giftCardId` | `string` | | -| `config` | `FindConfig`<`GiftCard`\> | | +| `giftCardId` | `string` | id of gift card to retrieve | +| `config` | `FindConfig`<`GiftCard`\> | optional values to include with gift card query | #### Returns `Promise`<`GiftCard`\> +the gift card + #### Defined in -[services/gift-card.ts:220](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L220) +[packages/medusa/src/services/gift-card.ts:216](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L216) ___ @@ -305,7 +337,7 @@ ___ #### Defined in -[services/gift-card.ts:229](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L229) +[packages/medusa/src/services/gift-card.ts:223](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L223) ___ @@ -326,7 +358,7 @@ ___ #### Defined in -[services/gift-card.ts:185](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L185) +[packages/medusa/src/services/gift-card.ts:182](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L182) ___ @@ -350,7 +382,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -358,20 +390,24 @@ ___ ▸ **update**(`giftCardId`, `update`): `Promise`<`GiftCard`\> +Updates a giftCard. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `giftCardId` | `string` | | -| `update` | `UpdateGiftCardInput` | | +| `giftCardId` | `string` | giftCard id of giftCard to update | +| `update` | `UpdateGiftCardInput` | the data to update the giftCard with | #### Returns `Promise`<`GiftCard`\> +the result of the update operation + #### Defined in -[services/gift-card.ts:244](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L244) +[packages/medusa/src/services/gift-card.ts:236](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L236) ___ @@ -395,7 +431,7 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) ___ @@ -403,10 +439,14 @@ ___ ▸ `Static` **generateCode**(): `string` +Generates a 16 character gift card code + #### Returns `string` +the generated gift card code + #### Defined in -[services/gift-card.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/gift-card.ts#L68) +[packages/medusa/src/services/gift-card.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/gift-card.ts#L68) diff --git a/docs/content/references/services/classes/IdempotencyKeyService.md b/docs/content/references/services/classes/IdempotencyKeyService.md index b64b8d6fbe..56df1c0cfc 100644 --- a/docs/content/references/services/classes/IdempotencyKeyService.md +++ b/docs/content/references/services/classes/IdempotencyKeyService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService` ↳ **`IdempotencyKeyService`** @@ -20,31 +20,118 @@ #### Overrides -BaseService.constructor +TransactionBaseService.constructor #### Defined in -[services/idempotency-key.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L8) +[packages/medusa/src/services/idempotency-key.js:8](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L8) + +## Properties + +### configModule + +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.configModule + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `any` + +#### Inherited from + +TransactionBaseService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + +___ + +### transactionManager\_ + +• `Protected` `Abstract` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L9) ## Methods -### create +### atomicPhase\_ -▸ **create**(`payload`): `Promise`<`IdempotencyKeyModel`\> +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | `any` | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) + +___ + +### create + +▸ **create**(`payload`): `Promise`<`IdempotencyKeyModel`\> + +Creates an idempotency key for a request. +If no idempotency key is provided in request, we will create a unique +identifier. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | `any` | payload of request to create idempotency key for | #### Returns `Promise`<`IdempotencyKeyModel`\> +the created idempotency key + #### Defined in -[services/idempotency-key.js:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L52) +[packages/medusa/src/services/idempotency-key.js:52](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L52) ___ @@ -52,22 +139,26 @@ ___ ▸ **initializeRequest**(`headerKey`, `reqMethod`, `reqParams`, `reqPath`): `Promise`<`IdempotencyKeyModel`\> +Execute the initial steps in a idempotent request. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `headerKey` | `string` | | -| `reqMethod` | `string` | | -| `reqParams` | `string` | | -| `reqPath` | `string` | | +| `headerKey` | `string` | potential idempotency key from header | +| `reqMethod` | `string` | method of request | +| `reqParams` | `string` | params of request | +| `reqPath` | `string` | path of request | #### Returns `Promise`<`IdempotencyKeyModel`\> +the existing or created idempotency key + #### Defined in -[services/idempotency-key.js:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L26) +[packages/medusa/src/services/idempotency-key.js:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L26) ___ @@ -75,19 +166,23 @@ ___ ▸ **lock**(`idempotencyKey`): `Promise`<`any`\> +Locks an idempotency. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `idempotencyKey` | `string` | | +| `idempotencyKey` | `string` | key to lock | #### Returns `Promise`<`any`\> +result of the update operation + #### Defined in -[services/idempotency-key.js:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L90) +[packages/medusa/src/services/idempotency-key.js:90](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L90) ___ @@ -95,19 +190,47 @@ ___ ▸ **retrieve**(`idempotencyKey`): `Promise`<`IdempotencyKeyModel`\> +Retrieves an idempotency key + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `idempotencyKey` | `string` | | +| `idempotencyKey` | `string` | key to retrieve | #### Returns `Promise`<`IdempotencyKeyModel`\> +idempotency key + #### Defined in -[services/idempotency-key.js:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L73) +[packages/medusa/src/services/idempotency-key.js:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L73) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -115,20 +238,48 @@ ___ ▸ **update**(`idempotencyKey`, `update`): `Promise`<`any`\> +Locks an idempotency. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `idempotencyKey` | `string` | | -| `update` | `any` | | +| `idempotencyKey` | `string` | key to update | +| `update` | `any` | update object | #### Returns `Promise`<`any`\> +result of the update operation + #### Defined in -[services/idempotency-key.js:117](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L117) +[packages/medusa/src/services/idempotency-key.js:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L117) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +`any` + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) ___ @@ -136,17 +287,25 @@ ___ ▸ **workStage**(`idempotencyKey`, `func`): `IdempotencyKeyModel` +Performs an atomic work stage. +An atomic work stage contains some related functionality, that needs to be +transactionally executed in isolation. An idempotent request will +always consist of 2 or more of these phases. The required phases are +"started" and "finished". + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `idempotencyKey` | `string` | | -| `func` | `Function` | | +| `idempotencyKey` | `string` | current idempotency key | +| `func` | `Function` | functionality to execute within the phase | #### Returns `IdempotencyKeyModel` +new updated idempotency key + #### Defined in -[services/idempotency-key.js:144](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/idempotency-key.js#L144) +[packages/medusa/src/services/idempotency-key.js:144](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/idempotency-key.js#L144) diff --git a/docs/content/references/services/classes/InventoryService.md b/docs/content/references/services/classes/InventoryService.md index 980432482f..eee732172e 100644 --- a/docs/content/references/services/classes/InventoryService.md +++ b/docs/content/references/services/classes/InventoryService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService`<[`InventoryService`](InventoryService.md)\> ↳ **`InventoryService`** @@ -16,36 +16,145 @@ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | +| `__namedParameters` | `InventoryServiceProps` | #### Overrides -BaseService.constructor +TransactionBaseService<InventoryService\>.constructor #### Defined in -[services/inventory.js:5](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/inventory.js#L5) +[packages/medusa/src/services/inventory.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L18) + +## Properties + +### configModule + +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.configModule + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `unknown` + +#### Inherited from + +TransactionBaseService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/inventory.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L15) + +___ + +### productVariantService\_ + +• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](ProductVariantService.md) + +#### Defined in + +[packages/medusa/src/services/inventory.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L13) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/inventory.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L16) ## Methods ### adjustInventory -▸ **adjustInventory**(`variantId`, `adjustment`): `Promise`<`any`\> +▸ **adjustInventory**(`variantId`, `adjustment`): `Promise`<`undefined` \| `ProductVariant`\> + +Updates the inventory of a variant based on a given adjustment. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `adjustment` | `number` | | +| `variantId` | `string` | the id of the variant to update | +| `adjustment` | `number` | the number to adjust the inventory quantity by | #### Returns -`Promise`<`any`\> +`Promise`<`undefined` \| `ProductVariant`\> + +resolves to the update result. #### Defined in -[services/inventory.js:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/inventory.js#L36) +[packages/medusa/src/services/inventory.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L31) + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -53,37 +162,71 @@ ___ ▸ **confirmInventory**(`variantId`, `quantity`): `Promise`<`boolean`\> +Checks if the inventory of a variant can cover a given quantity. Will +return true if the variant doesn't have managed inventory or if the variant +allows backorders or if the inventory quantity is greater than `quantity`. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `quantity` | `number` | | +| `variantId` | `undefined` \| ``null`` \| `string` | the id of the variant to check | +| `quantity` | `number` | the number of units to check availability for | #### Returns `Promise`<`boolean`\> +true if the inventory covers the quantity + #### Defined in -[services/inventory.js:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/inventory.js#L62) +[packages/medusa/src/services/inventory.ts:63](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/inventory.ts#L63) ___ -### withTransaction +### shouldRetryTransaction\_ -▸ **withTransaction**(`transactionManager`): [`InventoryService`](InventoryService.md) +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters | Name | Type | | :------ | :------ | -| `transactionManager` | `any` | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`InventoryService`](InventoryService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | #### Returns [`InventoryService`](InventoryService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[services/inventory.js:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/inventory.js#L15) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/LineItemService.md b/docs/content/references/services/classes/LineItemService.md index 77fa0481cf..1db3fc5cb5 100644 --- a/docs/content/references/services/classes/LineItemService.md +++ b/docs/content/references/services/classes/LineItemService.md @@ -1,5 +1,7 @@ # Class: LineItemService +Provides layer to manipulate line items. + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +26,7 @@ BaseService.constructor #### Defined in -[services/line-item.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L44) +[packages/medusa/src/services/line-item.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L44) ## Properties @@ -34,7 +36,7 @@ BaseService.constructor #### Defined in -[services/line-item.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L38) +[packages/medusa/src/services/line-item.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L38) ___ @@ -44,7 +46,7 @@ ___ #### Defined in -[services/line-item.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L37) +[packages/medusa/src/services/line-item.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L37) ___ @@ -54,7 +56,7 @@ ___ #### Defined in -[services/line-item.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L42) +[packages/medusa/src/services/line-item.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L42) ___ @@ -64,7 +66,7 @@ ___ #### Defined in -[services/line-item.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L36) +[packages/medusa/src/services/line-item.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L36) ___ @@ -74,7 +76,7 @@ ___ #### Defined in -[services/line-item.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L35) +[packages/medusa/src/services/line-item.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L35) ___ @@ -84,7 +86,7 @@ ___ #### Defined in -[services/line-item.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L40) +[packages/medusa/src/services/line-item.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L40) ___ @@ -94,7 +96,7 @@ ___ #### Defined in -[services/line-item.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L39) +[packages/medusa/src/services/line-item.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L39) ___ @@ -104,7 +106,7 @@ ___ #### Defined in -[services/line-item.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L41) +[packages/medusa/src/services/line-item.ts:41](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L41) ## Methods @@ -112,19 +114,23 @@ ___ ▸ **create**(`data`): `Promise`<`LineItem`\> +Create a line item + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `Partial`<`LineItem`\> | | +| `data` | `Partial`<`LineItem`\> | the line item object to create | #### Returns `Promise`<`LineItem`\> +the created line item + #### Defined in -[services/line-item.ts:270](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L270) +[packages/medusa/src/services/line-item.ts:262](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L262) ___ @@ -132,20 +138,25 @@ ___ ▸ **createReturnLines**(`returnId`, `cartId`): `Promise`<`LineItem`[]\> +Creates return line items for a given cart based on the return items in a +return. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `returnId` | `string` | | -| `cartId` | `string` | | +| `returnId` | `string` | the id to generate return items from. | +| `cartId` | `string` | the cart to assign the return line items to. | #### Returns `Promise`<`LineItem`[]\> +the created line items + #### Defined in -[services/line-item.ts:142](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L142) +[packages/medusa/src/services/line-item.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L134) ___ @@ -153,19 +164,23 @@ ___ ▸ **delete**(`id`): `Promise`<`undefined` \| `LineItem`\> +Deletes a line item. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | +| `id` | `string` | the id of the line item to delete | #### Returns `Promise`<`undefined` \| `LineItem`\> +the result of the delete operation + #### Defined in -[services/line-item.ts:318](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L318) +[packages/medusa/src/services/line-item.ts:310](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L310) ___ @@ -192,7 +207,7 @@ ___ #### Defined in -[services/line-item.ts:195](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L195) +[packages/medusa/src/services/line-item.ts:187](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L187) ___ @@ -217,7 +232,7 @@ ___ #### Defined in -[services/line-item.ts:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L90) +[packages/medusa/src/services/line-item.ts:90](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L90) ___ @@ -225,20 +240,24 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`LineItem`\> +Retrieves a line item by its id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `Object` | | +| `id` | `string` | the id of the line item to retrieve | +| `config` | `Object` | the config to be used at query building | #### Returns `Promise`<`LineItem`\> +the line item + #### Defined in -[services/line-item.ts:111](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L111) +[packages/medusa/src/services/line-item.ts:106](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L106) ___ @@ -246,20 +265,24 @@ ___ ▸ **update**(`id`, `data`): `Promise`<`LineItem`\> +Updates a line item + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `data` | `Partial`<`LineItem`\> | | +| `id` | `string` | the id of the line item to update | +| `data` | `Partial`<`LineItem`\> | the properties to update on line item | #### Returns `Promise`<`LineItem`\> +the update line item + #### Defined in -[services/line-item.ts:289](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L289) +[packages/medusa/src/services/line-item.ts:281](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L281) ___ @@ -279,4 +302,4 @@ ___ #### Defined in -[services/line-item.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/line-item.ts#L68) +[packages/medusa/src/services/line-item.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/line-item.ts#L68) diff --git a/docs/content/references/services/classes/MiddlewareService.md b/docs/content/references/services/classes/MiddlewareService.md index 862007e5b0..63f841ca96 100644 --- a/docs/content/references/services/classes/MiddlewareService.md +++ b/docs/content/references/services/classes/MiddlewareService.md @@ -1,60 +1,56 @@ # Class: MiddlewareService +Orchestrates dynamic middleware registered through the Medusa Middleware API + ## Constructors ### constructor -• **new MiddlewareService**(`container`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `container` | `any` | +• **new MiddlewareService**() #### Defined in -[services/middleware.js:7](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L7) +[packages/medusa/src/services/middleware.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L22) ## Properties ### postAuthentication\_ -• **postAuthentication\_**: `any`[] +• `Protected` `Readonly` **postAuthentication\_**: `middlewareType`[] #### Defined in -[services/middleware.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L8) +[packages/medusa/src/services/middleware.ts:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L17) ___ ### preAuthentication\_ -• **preAuthentication\_**: `any`[] +• `Protected` `Readonly` **preAuthentication\_**: `middlewareType`[] #### Defined in -[services/middleware.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L9) +[packages/medusa/src/services/middleware.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L18) ___ ### preCartCreation\_ -• **preCartCreation\_**: `any`[] +• `Protected` `Readonly` **preCartCreation\_**: `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>[] #### Defined in -[services/middleware.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L10) +[packages/medusa/src/services/middleware.ts:19](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L19) ___ ### routers -• **routers**: `Object` +• `Protected` `Readonly` **routers**: `Record`<`string`, `Router`[]\> #### Defined in -[services/middleware.js:11](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L11) +[packages/medusa/src/services/middleware.ts:20](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L20) ## Methods @@ -62,20 +58,24 @@ ___ ▸ **addPostAuthentication**(`middleware`, `options`): `void` +Adds a middleware function to be called after authentication is completed. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `middleware` | `Function` | | -| `options` | `any` | | +| `middleware` | `middlewareHandlerType` | the middleware function. Should return a middleware function. | +| `options` | `Record`<`string`, `unknown`\> | the arguments that will be passed to the middleware | #### Returns `void` +void + #### Defined in -[services/middleware.js:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L45) +[packages/medusa/src/services/middleware.ts:60](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L60) ___ @@ -83,20 +83,24 @@ ___ ▸ **addPreAuthentication**(`middleware`, `options`): `void` +Adds a middleware function to be called before authentication is completed. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `middleware` | `Function` | | -| `options` | `any` | | +| `middleware` | `middlewareHandlerType` | the middleware function. Should return a middleware function. | +| `options` | `Record`<`string`, `unknown`\> | the arguments that will be passed to the middleware | #### Returns `void` +void + #### Defined in -[services/middleware.js:61](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L61) +[packages/medusa/src/services/middleware.ts:79](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L79) ___ @@ -104,11 +108,13 @@ ___ ▸ **addPreCartCreation**(`middleware`): `void` +Adds a middleware function to be called before cart creation + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `middleware` | `Function` | | +| `middleware` | `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> | the middleware function. Should return a middleware function. | #### Returns @@ -116,7 +122,7 @@ ___ #### Defined in -[services/middleware.js:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L75) +[packages/medusa/src/services/middleware.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L96) ___ @@ -128,8 +134,8 @@ ___ | Name | Type | | :------ | :------ | -| `path` | `any` | -| `router` | `any` | +| `path` | `string` | +| `router` | `Router` | #### Returns @@ -137,27 +143,27 @@ ___ #### Defined in -[services/middleware.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L14) +[packages/medusa/src/services/middleware.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L29) ___ ### getRouters -▸ **getRouters**(`path`): `any` +▸ **getRouters**(`path`): `Router`[] #### Parameters | Name | Type | | :------ | :------ | -| `path` | `any` | +| `path` | `string` | #### Returns -`any` +`Router`[] #### Defined in -[services/middleware.js:19](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L19) +[packages/medusa/src/services/middleware.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L34) ___ @@ -165,11 +171,13 @@ ___ ▸ **usePostAuthentication**(`app`): `void` +Adds post authentication middleware to an express app. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `app` | `ExpressApp` | | +| `app` | `Router` | the express app to add the middleware to | #### Returns @@ -177,7 +185,7 @@ ___ #### Defined in -[services/middleware.js:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L85) +[packages/medusa/src/services/middleware.ts:106](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L106) ___ @@ -185,11 +193,13 @@ ___ ▸ **usePreAuthentication**(`app`): `void` +Adds pre authentication middleware to an express app. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `app` | `ExpressApp` | | +| `app` | `Router` | the express app to add the middleware to | #### Returns @@ -197,21 +207,21 @@ ___ #### Defined in -[services/middleware.js:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L96) +[packages/medusa/src/services/middleware.ts:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L117) ___ ### usePreCartCreation -▸ **usePreCartCreation**(): `any`[] +▸ **usePreCartCreation**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>[] #### Returns -`any`[] +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>[] #### Defined in -[services/middleware.js:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L102) +[packages/medusa/src/services/middleware.ts:123](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L123) ___ @@ -219,16 +229,20 @@ ___ ▸ **validateMiddleware_**(`fn`): `void` +Validates a middleware function, throws if fn is not of type function. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `fn` | `Function` | | +| `fn` | `unknown` | the middleware function to validate. | #### Returns `void` +nothing if the middleware is a function + #### Defined in -[services/middleware.js:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/middleware.js#L28) +[packages/medusa/src/services/middleware.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/middleware.ts#L43) diff --git a/docs/content/references/services/classes/NoteService.md b/docs/content/references/services/classes/NoteService.md index fb1a70a2f5..63d541ce1e 100644 --- a/docs/content/references/services/classes/NoteService.md +++ b/docs/content/references/services/classes/NoteService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService`<[`NoteService`](NoteService.md)\> ↳ **`NoteService`** @@ -16,21 +16,97 @@ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | +| `__namedParameters` | `InjectedDependencies` | #### Overrides -BaseService.constructor +TransactionBaseService<NoteService\>.constructor #### Defined in -[services/note.js:12](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L12) +[packages/medusa/src/services/note.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L29) ## Properties +### configModule + +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.configModule + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `unknown` + +#### Inherited from + +TransactionBaseService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md) + +#### Defined in + +[packages/medusa/src/services/note.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L27) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/note.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L24) + +___ + +### noteRepository\_ + +• `Protected` `Readonly` **noteRepository\_**: typeof `NoteRepository` + +#### Defined in + +[packages/medusa/src/services/note.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L26) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/note.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L25) + +___ + ### Events -▪ `Static` **Events**: `Object` +▪ `Static` `Readonly` **Events**: `Object` #### Type declaration @@ -42,48 +118,94 @@ BaseService.constructor #### Defined in -[services/note.js:6](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L6) +[packages/medusa/src/services/note.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L18) ## Methods -### create +### atomicPhase\_ -▸ **create**(`data`, `config?`): `Promise`<`any`\> +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `CreateNoteInput` | | -| `config` | `any` | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns -`Promise`<`any`\> +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ #### Defined in -[services/note.js:98](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L98) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) + +___ + +### create + +▸ **create**(`data`, `config?`): `Promise`<`Note`\> + +Creates a note associated with a given author + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | `CreateNoteInput` | the note to create | +| `config` | `Object` | any configurations if needed, including meta data | +| `config.metadata` | `Record`<`string`, `unknown`\> | - | + +#### Returns + +`Promise`<`Note`\> + +resolves to the creation result + +#### Defined in + +[packages/medusa/src/services/note.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L96) ___ ### delete -▸ **delete**(`noteId`): `Promise`<`any`\> +▸ **delete**(`noteId`): `Promise`<`void`\> + +Deletes a given note #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `noteId` | `any` | | +| `noteId` | `string` | id of the note to delete | #### Returns -`Promise`<`any`\> +`Promise`<`void`\> #### Defined in -[services/note.js:154](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L154) +[packages/medusa/src/services/note.ts:154](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L154) ___ @@ -91,23 +213,24 @@ ___ ▸ **list**(`selector`, `config?`): `Promise`<`Note`[]\> +Fetches all notes related to the given selector + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `Object` | | -| `config.relations` | `string`[] | | -| `config.skip` | `number` | | -| `config.take` | `number` | | +| `selector` | `Selector`<`Note`\> | the query object for find | +| `config` | `FindConfig`<`Note`\> | the configuration used to find the objects. contains relations, skip, and take. | #### Returns `Promise`<`Note`[]\> +notes related to the given search. + #### Defined in -[services/note.js:77](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L77) +[packages/medusa/src/services/note.ts:75](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L75) ___ @@ -115,58 +238,94 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`Note`\> +Retrieves a specific note. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `any` | | +| `id` | `string` | the id of the note to retrieve. | +| `config` | `FindConfig`<`Note`\> | any options needed to query for the result. | #### Returns `Promise`<`Note`\> +which resolves to the requested note. + #### Defined in -[services/note.js:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L51) +[packages/medusa/src/services/note.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L47) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ ### update -▸ **update**(`noteId`, `value`): `Promise`<`any`\> +▸ **update**(`noteId`, `value`): `Promise`<`Note`\> + +Updates a given note with a new value #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `noteId` | `any` | | -| `value` | `any` | | +| `noteId` | `string` | the id of the note to update | +| `value` | `string` | the new value | #### Returns -`Promise`<`any`\> +`Promise`<`Note`\> + +resolves to the updated element #### Defined in -[services/note.js:131](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L131) +[packages/medusa/src/services/note.ts:132](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/note.ts#L132) ___ ### withTransaction -▸ **withTransaction**(`transactionManager`): [`NoteService`](NoteService.md) +▸ **withTransaction**(`transactionManager?`): [`NoteService`](NoteService.md) #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionManager` | `EntityManager` | | +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | #### Returns [`NoteService`](NoteService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[services/note.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/note.js#L30) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/NotificationService.md b/docs/content/references/services/classes/NotificationService.md index b527aa45d7..1d798ec018 100644 --- a/docs/content/references/services/classes/NotificationService.md +++ b/docs/content/references/services/classes/NotificationService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService`<[`NotificationService`](NotificationService.md)\> ↳ **`NotificationService`** @@ -16,107 +16,222 @@ | Name | Type | | :------ | :------ | -| `container` | `any` | +| `container` | `InjectedDependencies` | #### Overrides -BaseService.constructor +TransactionBaseService<NotificationService\>.constructor #### Defined in -[services/notification.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L9) +[packages/medusa/src/services/notification.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L35) ## Properties ### attachmentGenerator\_ -• **attachmentGenerator\_**: `any` +• `Protected` **attachmentGenerator\_**: `unknown` = `null` #### Defined in -[services/notification.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L30) +[packages/medusa/src/services/notification.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L27) + +___ + +### configModule + +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.configModule + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `unknown` + +#### Inherited from + +TransactionBaseService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) ___ ### container\_ -• **container\_**: `any` +• `Protected` `Readonly` **container\_**: `InjectedDependencies` & {} #### Defined in -[services/notification.js:19](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L19) +[packages/medusa/src/services/notification.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L28) ___ ### logger\_ -• **logger\_**: `any` +• `Protected` `Readonly` **logger\_**: `Logger` #### Defined in -[services/notification.js:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L23) +[packages/medusa/src/services/notification.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L31) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/notification.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L23) ___ ### notificationProviderRepository\_ -• **notificationProviderRepository\_**: `any` +• `Protected` `Readonly` **notificationProviderRepository\_**: typeof `NotificationProviderRepository` #### Defined in -[services/notification.js:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L27) +[packages/medusa/src/services/notification.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L33) + +___ + +### notificationRepository\_ + +• `Protected` `Readonly` **notificationRepository\_**: typeof `NotificationRepository` + +#### Defined in + +[packages/medusa/src/services/notification.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L32) ___ ### subscribers\_ -• **subscribers\_**: `Object` +• `Protected` **subscribers\_**: `Object` = `{}` #### Defined in -[services/notification.js:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L29) +[packages/medusa/src/services/notification.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L26) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/notification.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L24) ## Methods -### handleEvent +### atomicPhase\_ -▸ **handleEvent**(`eventName`, `data`): `Promise`<`any`\> +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `eventName` | `string` | | -| `data` | `any` | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns -`Promise`<`any`\> +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ #### Defined in -[services/notification.js:166](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L166) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) + +___ + +### handleEvent + +▸ **handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| `Notification`[]\> + +Handles an event by relaying the event data to the subscribing providers. +The result of the notification send will be persisted in the database in +order to allow for resends. Will log any errors that are encountered. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` | the event to handle | +| `data` | `Record`<`string`, `unknown`\> | the data the event was sent with | + +#### Returns + +`Promise`<`undefined` \| `void` \| `Notification`[]\> + +the result of notification subscribed + +#### Defined in + +[packages/medusa/src/services/notification.ts:173](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L173) ___ ### list -▸ **list**(`selector`, `config?`): `Notification`[] +▸ **list**(`selector`, `config?`): `Promise`<`Notification`[]\> + +Retrieves a list of notifications. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `selector` | `Selector`<`Notification`\> | the params to select the notifications by. | +| `config` | `FindConfig`<`Notification`\> | the configuration to apply to the query | #### Returns -`Notification`[] +`Promise`<`Notification`[]\> + +the notifications that satisfy the query. #### Defined in -[services/notification.js:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L84) +[packages/medusa/src/services/notification.ts:85](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L85) ___ @@ -124,11 +239,14 @@ ___ ▸ **registerAttachmentGenerator**(`service`): `void` +Registers an attachment generator to the service. The generator can be +used to generate on demand invoices or other documents. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `service` | `any` | | +| `service` | `unknown` | the service to assign to the attachmentGenerator | #### Returns @@ -136,19 +254,21 @@ ___ #### Defined in -[services/notification.js:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L38) +[packages/medusa/src/services/notification.ts:61](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L61) ___ ### registerInstalledProviders -▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\> +▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\> + +Takes a list of notification provider ids and persists them in the database. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `providers` | `string`[] | | +| `providerIds` | `string`[] | a list of provider ids | #### Returns @@ -156,91 +276,134 @@ ___ #### Defined in -[services/notification.js:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L68) +[packages/medusa/src/services/notification.ts:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L69) ___ ### resend -▸ **resend**(`id`, `config?`): `Notification` +▸ **resend**(`id`, `config?`): `Promise`<`Notification`\> + +Resends a notification by retrieving a prior notification and calling the +underlying provider's resendNotification method. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `any` | | +| `id` | `string` | the id of the notification | +| `config` | `FindConfig`<`Notification`\> | any configuration that might override the previous send | #### Returns -`Notification` +`Promise`<`Notification`\> + +the newly created notification #### Defined in -[services/notification.js:237](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L237) +[packages/medusa/src/services/notification.ts:253](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L253) ___ ### retrieve -▸ **retrieve**(`id`, `config?`): `Notification` +▸ **retrieve**(`id`, `config?`): `Promise`<`Notification`\> + +Retrieves a notification with a given id #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `any` | | +| `id` | `string` | the id of the notification | +| `config` | `FindConfig`<`Notification`\> | the configuration to apply to the query | #### Returns -`Notification` +`Promise`<`Notification`\> + +the notification #### Defined in -[services/notification.js:101](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L101) +[packages/medusa/src/services/notification.ts:106](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L106) ___ ### retrieveProvider\_ -▸ **retrieveProvider_**(`id`): `NotificationProvider` +▸ `Protected` **retrieveProvider_**(`id`): `AbstractNotificationService`<`never`\> + +Finds a provider with a given id. Will throw a NOT_FOUND error if the +resolution fails. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | +| `id` | `string` | the id of the provider | #### Returns -`NotificationProvider` +`AbstractNotificationService`<`never`\> + +the notification provider #### Defined in -[services/notification.js:147](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L147) +[packages/medusa/src/services/notification.ts:154](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L154) ___ ### send -▸ **send**(`event`, `eventData`, `providerId`): `Notification` +▸ **send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| `Notification`\> + +Sends a notification, by calling the given provider's sendNotification +method. Persists the Notification in the database. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `event` | `string` | | -| `eventData` | `any` | | -| `providerId` | `string` | | +| `event` | `string` | the name of the event | +| `eventData` | `Record`<`string`, `unknown`\> | the data the event was sent with | +| `providerId` | `string` | the provider that should hande the event. | #### Returns -`Notification` +`Promise`<`undefined` \| `Notification`\> + +the created notification #### Defined in -[services/notification.js:195](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L195) +[packages/medusa/src/services/notification.ts:205](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L205) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -248,12 +411,14 @@ ___ ▸ **subscribe**(`eventName`, `providerId`): `void` +Subscribes a given provider to an event. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `eventName` | `string` | | -| `providerId` | `string` | | +| `eventName` | `string` | the event to subscribe to | +| `providerId` | `string` | the provider that the event will be sent to | #### Returns @@ -261,24 +426,28 @@ ___ #### Defined in -[services/notification.js:126](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L126) +[packages/medusa/src/services/notification.ts:133](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/notification.ts#L133) ___ ### withTransaction -▸ **withTransaction**(`transactionManager`): [`NotificationService`](NotificationService.md) +▸ **withTransaction**(`transactionManager?`): [`NotificationService`](NotificationService.md) #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionManager` | `EntityManager` | | +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | #### Returns [`NotificationService`](NotificationService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[services/notification.js:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/notification.js#L47) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/OauthService.md b/docs/content/references/services/classes/OauthService.md index b84ce7e5cf..062cec84b7 100644 --- a/docs/content/references/services/classes/OauthService.md +++ b/docs/content/references/services/classes/OauthService.md @@ -24,7 +24,7 @@ OauthService.constructor #### Defined in -[services/oauth.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L10) +[packages/medusa/src/services/oauth.js:10](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L10) ## Properties @@ -34,7 +34,7 @@ OauthService.constructor #### Defined in -[services/oauth.js:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L15) +[packages/medusa/src/services/oauth.js:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L15) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[services/oauth.js:17](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L17) +[packages/medusa/src/services/oauth.js:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L17) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[services/oauth.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L14) +[packages/medusa/src/services/oauth.js:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L14) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[services/oauth.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L16) +[packages/medusa/src/services/oauth.js:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L16) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[services/oauth.js:5](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L5) +[packages/medusa/src/services/oauth.js:5](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L5) ## Methods @@ -101,7 +101,7 @@ ___ #### Defined in -[services/oauth.js:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L32) +[packages/medusa/src/services/oauth.js:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L32) ___ @@ -123,7 +123,7 @@ ___ #### Defined in -[services/oauth.js:66](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L66) +[packages/medusa/src/services/oauth.js:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L66) ___ @@ -143,7 +143,7 @@ ___ #### Defined in -[services/oauth.js:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L27) +[packages/medusa/src/services/oauth.js:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L27) ___ @@ -163,7 +163,7 @@ ___ #### Defined in -[services/oauth.js:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L96) +[packages/medusa/src/services/oauth.js:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L96) ___ @@ -183,7 +183,7 @@ ___ #### Defined in -[services/oauth.js:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L56) +[packages/medusa/src/services/oauth.js:56](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L56) ___ @@ -203,7 +203,7 @@ ___ #### Defined in -[services/oauth.js:20](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L20) +[packages/medusa/src/services/oauth.js:20](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L20) ___ @@ -224,4 +224,4 @@ ___ #### Defined in -[services/oauth.js:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/oauth.js#L45) +[packages/medusa/src/services/oauth.js:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/oauth.js#L45) diff --git a/docs/content/references/services/classes/OrderService.md b/docs/content/references/services/classes/OrderService.md index a3155398f0..1a8a15d938 100644 --- a/docs/content/references/services/classes/OrderService.md +++ b/docs/content/references/services/classes/OrderService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService`<[`OrderService`](OrderService.md)\> ↳ **`OrderService`** @@ -16,21 +16,247 @@ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | +| `__namedParameters` | `InjectedDependencies` | #### Overrides -BaseService.constructor +TransactionBaseService<OrderService\>.constructor #### Defined in -[services/order.js:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L25) +[packages/medusa/src/services/order.ts:107](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L107) ## Properties +### addressRepository\_ + +• `Protected` `Readonly` **addressRepository\_**: typeof `AddressRepository` + +#### Defined in + +[packages/medusa/src/services/order.ts:101](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L101) + +___ + +### cartService\_ + +• `Protected` `Readonly` **cartService\_**: [`CartService`](CartService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:100](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L100) + +___ + +### configModule + +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.configModule + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `unknown` + +#### Inherited from + +TransactionBaseService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + +___ + +### customerService\_ + +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](CustomerService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:90](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L90) + +___ + +### discountService\_ + +• `Protected` `Readonly` **discountService\_**: [`DiscountService`](DiscountService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:94](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L94) + +___ + +### draftOrderService\_ + +• `Protected` `Readonly` **draftOrderService\_**: [`DraftOrderService`](DraftOrderService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:103](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L103) + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:105](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L105) + +___ + +### fulfillmentProviderService\_ + +• `Protected` `Readonly` **fulfillmentProviderService\_**: [`FulfillmentProviderService`](FulfillmentProviderService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:95](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L95) + +___ + +### fulfillmentService\_ + +• `Protected` `Readonly` **fulfillmentService\_**: [`FulfillmentService`](FulfillmentService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L96) + +___ + +### giftCardService\_ + +• `Protected` `Readonly` **giftCardService\_**: [`GiftCardService`](GiftCardService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:102](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L102) + +___ + +### inventoryService\_ + +• `Protected` `Readonly` **inventoryService\_**: [`InventoryService`](InventoryService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:104](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L104) + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:97](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L97) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/order.ts:86](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L86) + +___ + +### orderRepository\_ + +• `Protected` `Readonly` **orderRepository\_**: typeof `OrderRepository` + +#### Defined in + +[packages/medusa/src/services/order.ts:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L89) + +___ + +### paymentProviderService\_ + +• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](PaymentProviderService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:91](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L91) + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:99](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L99) + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:92](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L92) + +___ + +### shippingProfileService\_ + +• `Protected` `Readonly` **shippingProfileService\_**: [`ShippingProfileService`](ShippingProfileService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:93](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L93) + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](TotalsService.md) + +#### Defined in + +[packages/medusa/src/services/order.ts:98](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L98) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/order.ts:87](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L87) + +___ + ### Events -▪ `Static` **Events**: `Object` +▪ `Static` `Readonly` **Events**: `Object` #### Type declaration @@ -55,293 +281,22 @@ BaseService.constructor #### Defined in -[services/order.js:6](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L6) +[packages/medusa/src/services/order.ts:67](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L67) ## Methods ### addShippingMethod -▸ **addShippingMethod**(`orderId`, `optionId`, `data`, `config?`): `Promise`<`any`\> +▸ **addShippingMethod**(`orderId`, `optionId`, `data?`, `config?`): `Promise`<`Order`\> #### Parameters | Name | Type | | :------ | :------ | -| `orderId` | `any` | -| `optionId` | `any` | -| `data` | `any` | -| `config` | `Object` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:806](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L806) - -___ - -### archive - -▸ **archive**(`orderId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orderId` | `string` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:1302](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1302) - -___ - -### cancel - -▸ **cancel**(`orderId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orderId` | `string` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:952](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L952) - -___ - -### cancelFulfillment - -▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fulfillmentId` | `string` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:1243](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1243) - -___ - -### capturePayment - -▸ **capturePayment**(`orderId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orderId` | `string` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:1021](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1021) - -___ - -### completeOrder - -▸ **completeOrder**(`orderId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orderId` | `string` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:429](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L429) - -___ - -### create - -▸ **create**(`data`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | `any` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:723](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L723) - -___ - -### createFromCart - -▸ **createFromCart**(`cartId`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cartId` | `string` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:465](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L465) - -___ - -### createFulfillment - -▸ **createFulfillment**(`orderId`, `itemsToFulfill`, `config?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orderId` | `string` | | -| `itemsToFulfill` | `any` | | -| `config` | `any` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:1121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1121) - -___ - -### createRefund - -▸ **createRefund**(`orderId`, `refundAmount`, `reason`, `note`, `config?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orderId` | `string` | | -| `refundAmount` | `float` | | -| `reason` | `string` | | -| `note` | `undefined` \| `string` | | -| `config` | `any` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:1329](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1329) - -___ - -### createShipment - -▸ **createShipment**(`orderId`, `fulfillmentId`, `trackingLinks`, `config?`): `order` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orderId` | `string` | | -| `fulfillmentId` | `string` | | -| `trackingLinks` | `undefined` \| `TrackingLink`[] | | -| `config` | `any` | | - -#### Returns - -`order` - -#### Defined in - -[services/order.js:643](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L643) - -___ - -### decorateTotals\_ - -▸ **decorateTotals_**(`order`, `totalsFields?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `order` | `any` | `undefined` | -| `totalsFields` | `any`[] | `[]` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:1378](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1378) - -___ - -### deleteMetadata - -▸ **deleteMetadata**(`orderId`, `key`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `orderId` | `string` | | -| `key` | `string` | | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[services/order.js:1553](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1553) - -___ - -### existsByCartId - -▸ **existsByCartId**(`cartId`): `Promise`<`Order`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `cartId` | `string` | | +| `orderId` | `string` | +| `optionId` | `string` | +| `data?` | `Record`<`string`, `unknown`\> | +| `config` | `CreateShippingMethodDto` | #### Returns @@ -349,99 +304,429 @@ ___ #### Defined in -[services/order.js:417](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L417) +[packages/medusa/src/services/order.ts:813](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L813) ___ -### getFulfillmentItems\_ +### archive -▸ **getFulfillmentItems_**(`order`, `items`, `transformer`): `Promise`<`LineItem`[]\> +▸ **archive**(`orderId`): `Promise`<`Order`\> + +Archives an order. It only alloved, if the order has been fulfilled +and payment has been captured. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | -| `items` | `Object` | | -| `items.item_id` | `string` | - | -| `items.quantity` | `number` | - | -| `transformer` | `Function` | | +| `orderId` | `string` | the order to archive | #### Returns -`Promise`<`LineItem`[]\> +`Promise`<`Order`\> + +the result of the update operation #### Defined in -[services/order.js:1285](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1285) +[packages/medusa/src/services/order.ts:1337](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1337) ___ -### list +### atomicPhase\_ -▸ **list**(`selector`, `config?`): `Promise`<`any`\> +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns -`Promise`<`any`\> +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ #### Defined in -[services/order.js:148](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L148) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ -### listAndCount +### cancel -▸ **listAndCount**(`selector`, `config?`): `Promise`<`any`[]\> +▸ **cancel**(`orderId`): `Promise`<`Order`\> + +Cancels an order. +Throws if fulfillment process has been initiated. +Throws if payment process has been initiated. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of order to cancel. | + +#### Returns + +`Promise`<`Order`\> + +result of the update operation. + +#### Defined in + +[packages/medusa/src/services/order.ts:964](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L964) + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<`Order`\> + +Cancels a fulfillment (if related to an order) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fulfillmentId` | `string` | the ID of the fulfillment to cancel | + +#### Returns + +`Promise`<`Order`\> + +updated order + +#### Defined in + +[packages/medusa/src/services/order.ts:1274](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1274) + +___ + +### capturePayment + +▸ **capturePayment**(`orderId`): `Promise`<`Order`\> + +Captures payment for an order. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of order to capture payment for. | + +#### Returns + +`Promise`<`Order`\> + +result of the update operation. + +#### Defined in + +[packages/medusa/src/services/order.ts:1043](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1043) + +___ + +### completeOrder + +▸ **completeOrder**(`orderId`): `Promise`<`Order`\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of the order to complete | + +#### Returns + +`Promise`<`Order`\> + +the result of the find operation + +#### Defined in + +[packages/medusa/src/services/order.ts:451](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L451) + +___ + +### createFromCart + +▸ **createFromCart**(`cartId`): `Promise`<`Order`\> + +Creates an order from a cart + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | id of the cart to create an order from | + +#### Returns + +`Promise`<`Order`\> + +resolves to the creation result. + +#### Defined in + +[packages/medusa/src/services/order.ts:479](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L479) + +___ + +### createFulfillment + +▸ **createFulfillment**(`orderId`, `itemsToFulfill`, `config?`): `Promise`<`Order`\> + +Creates fulfillments for an order. +In a situation where the order has more than one shipping method, +we need to partition the order items, such that they can be sent +to their respective fulfillment provider. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of order to cancel. | +| `itemsToFulfill` | `FulFillmentItemType`[] | items to fulfil. | +| `config` | `Object` | the config to cancel. | +| `config.metadata?` | `Record`<`string`, `unknown`\> | - | +| `config.no_notification?` | `boolean` | - | + +#### Returns + +`Promise`<`Order`\> + +result of the update operation. + +#### Defined in + +[packages/medusa/src/services/order.ts:1146](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1146) + +___ + +### createRefund + +▸ **createRefund**(`orderId`, `refundAmount`, `reason`, `note?`, `config?`): `Promise`<`Order`\> + +Refunds a given amount back to the customer. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of the order to refund. | +| `refundAmount` | `number` | the amount to refund. | +| `reason` | `string` | the reason to refund. | +| `note?` | `string` | note for refund. | +| `config` | `Object` | the config for refund. | +| `config.no_notification?` | `boolean` | - | + +#### Returns + +`Promise`<`Order`\> + +the result of the refund operation. + +#### Defined in + +[packages/medusa/src/services/order.ts:1363](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1363) + +___ + +### createShipment + +▸ **createShipment**(`orderId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<`Order`\> + +Adds a shipment to the order to indicate that an order has left the +warehouse. Will ask the fulfillment provider for any documents that may +have been created in regards to the shipment. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | the id of the order that has been shipped | +| `fulfillmentId` | `string` | the fulfillment that has now been shipped | +| `trackingLinks?` | `TrackingLink`[] | array of tracking numebers associated with the shipment | +| `config` | `Object` | the config of the order that has been shipped | +| `config.metadata` | `Record`<`string`, `unknown`\> | - | +| `config.no_notification?` | `boolean` | - | + +#### Returns + +`Promise`<`Order`\> + +the resulting order following the update. + +#### Defined in + +[packages/medusa/src/services/order.ts:655](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L655) + +___ + +### decorateTotals + +▸ `Protected` **decorateTotals**(`order`, `totalsFields?`): `Promise`<`Order`\> #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | -| `selector` | `any` | `undefined` | -| `config` | `Object` | `undefined` | -| `config.order` | `Object` | `undefined` | -| `config.order.created_at` | `string` | `"DESC"` | -| `config.skip` | `number` | `0` | -| `config.take` | `number` | `50` | +| `order` | `Order` | `undefined` | +| `totalsFields` | `string`[] | `[]` | #### Returns -`Promise`<`any`[]\> +`Promise`<`Order`\> #### Defined in -[services/order.js:173](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L173) +[packages/medusa/src/services/order.ts:1412](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1412) ___ -### registerReturnReceived +### existsByCartId -▸ **registerReturnReceived**(`orderId`, `receivedReturn`, `customRefundAmount`): `Promise`<`any`\> +▸ **existsByCartId**(`cartId`): `Promise`<`boolean`\> + +Checks the existence of an order by cart id. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `orderId` | `string` | | -| `receivedReturn` | `any` | | -| `customRefundAmount` | `float` | | +| `cartId` | `string` | cart id to find order | #### Returns -`Promise`<`any`\> +`Promise`<`boolean`\> + +the order document #### Defined in -[services/order.js:1476](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1476) +[packages/medusa/src/services/order.ts:442](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L442) + +___ + +### getFulfillmentItems + +▸ `Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<`LineItem`[]\> + +Retrieves the order line items, given an array of items. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | `Order` | the order to get line items from | +| `items` | `FulFillmentItemType`[] | the items to get | +| `transformer` | (`item`: `undefined` \| `LineItem`, `quantity`: `number`) => `unknown` | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. | + +#### Returns + +`Promise`<`LineItem`[]\> + +the line items generated by the transformer. + +#### Defined in + +[packages/medusa/src/services/order.ts:1316](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1316) + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<`Order`[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `Selector`<`Order`\> | the query object for find | +| `config` | `FindConfig`<`Order`\> | the config to be used for find | + +#### Returns + +`Promise`<`Order`[]\> + +the result of the find operation + +#### Defined in + +[packages/medusa/src/services/order.ts:155](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L155) + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Order`[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | `QuerySelector`<`Order`\> | +| `config` | `FindConfig`<`Order`\> | + +#### Returns + +`Promise`<[`Order`[], `number`]\> + +#### Defined in + +[packages/medusa/src/services/order.ts:184](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L184) + +___ + +### registerReturnReceived + +▸ **registerReturnReceived**(`orderId`, `receivedReturn`, `customRefundAmount?`): `Promise`<`Order`\> + +Handles receiving a return. This will create a +refund to the customer. If the returned items don't match the requested +items the return status will be updated to requires_action. This behaviour +is useful in sitautions where a custom refund amount is requested, but the +retuned items are not matching the requested items. Setting the +allowMismatch argument to true, will process the return, ignoring any +mismatches. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | the order to return. | +| `receivedReturn` | `Return` | the received return | +| `customRefundAmount?` | `number` | the custom refund amount return | + +#### Returns + +`Promise`<`Order`\> + +the result of the update operation + +#### Defined in + +[packages/medusa/src/services/order.ts:1515](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1515) ___ @@ -449,20 +734,24 @@ ___ ▸ **retrieve**(`orderId`, `config?`): `Promise`<`Order`\> +Gets an order by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `orderId` | `string` | | -| `config` | `any` | | +| `orderId` | `string` | id of order to retrieve | +| `config` | `FindConfig`<`Order`\> | config of order to retrieve | #### Returns `Promise`<`Order`\> +the order document + #### Defined in -[services/order.js:305](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L305) +[packages/medusa/src/services/order.ts:324](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L324) ___ @@ -470,20 +759,24 @@ ___ ▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<`Order`\> +Gets an order by cart id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartId` | `string` | | -| `config` | `any` | | +| `cartId` | `string` | cart id to find order | +| `config` | `FindConfig`<`Order`\> | the config to be used to find order | #### Returns `Promise`<`Order`\> +the order document + #### Defined in -[services/order.js:343](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L343) +[packages/medusa/src/services/order.ts:364](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L364) ___ @@ -491,161 +784,201 @@ ___ ▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<`Order`\> +Gets an order by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `externalId` | `string` | | -| `config` | `any` | | +| `externalId` | `string` | id of order to retrieve | +| `config` | `FindConfig`<`Order`\> | query config to get order by | #### Returns `Promise`<`Order`\> +the order document + #### Defined in -[services/order.js:380](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L380) +[packages/medusa/src/services/order.ts:403](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L403) ___ -### transformQueryForTotals\_ +### shouldRetryTransaction\_ -▸ **transformQueryForTotals_**(`config`): { `relations`: `any` ; `select`: `any` ; `totalsToSelect`: `never`[] = [] } \| { `relations`: `any` ; `select`: `any`[] = toSelect; `totalsToSelect`: `any` } +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters | Name | Type | | :------ | :------ | -| `config` | `any` | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | #### Returns -{ `relations`: `any` ; `select`: `any` ; `totalsToSelect`: `never`[] = [] } \| { `relations`: `any` ; `select`: `any`[] = toSelect; `totalsToSelect`: `any` } +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[services/order.js:234](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L234) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) + +___ + +### transformQueryForTotals + +▸ `Protected` **transformQueryForTotals**(`config`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `FindConfig`<`Order`\> | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `relations` | `undefined` \| `string`[] | +| `select` | `undefined` \| keyof `Order`[] | +| `totalsToSelect` | `undefined` \| keyof `Order`[] | + +#### Defined in + +[packages/medusa/src/services/order.ts:249](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L249) ___ ### update -▸ **update**(`orderId`, `update`): `Promise`<`any`\> +▸ **update**(`orderId`, `update`): `Promise`<`Order`\> + +Updates an order. Metadata updates should +use dedicated method, e.g. `setMetadata` etc. The function +will throw errors if metadata updates are attempted. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `orderId` | `string` | | -| `update` | `any` | | +| `orderId` | `string` | the id of the order. Must be a string that can be casted to an ObjectId | +| `update` | `UpdateOrderInput` | an object with the update values. | #### Returns -`Promise`<`any`\> +`Promise`<`Order`\> + +resolves to the update result. #### Defined in -[services/order.js:864](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L864) +[packages/medusa/src/services/order.ts:876](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L876) ___ -### updateBillingAddress\_ +### updateBillingAddress -▸ **updateBillingAddress_**(`order`, `address`): `Promise`<`any`\> +▸ `Protected` **updateBillingAddress**(`order`, `address`): `Promise`<`void`\> + +Updates the order's billing address. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `any` | | -| `address` | `any` | | +| `order` | `Order` | the order to update | +| `address` | `Address` | the value to set the billing address to | #### Returns -`Promise`<`any`\> +`Promise`<`void`\> + +the result of the update operation #### Defined in -[services/order.js:744](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L744) +[packages/medusa/src/services/order.ts:741](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L741) ___ -### updateShippingAddress\_ +### updateShippingAddress -▸ **updateShippingAddress_**(`order`, `address`): `Promise`<`any`\> +▸ `Protected` **updateShippingAddress**(`order`, `address`): `Promise`<`void`\> + +Updates the order's shipping address. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `any` | | -| `address` | `any` | | +| `order` | `Order` | the order to update | +| `address` | `Address` | the value to set the shipping address to | #### Returns -`Promise`<`any`\> +`Promise`<`void`\> + +the result of the update operation #### Defined in -[services/order.js:779](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L779) +[packages/medusa/src/services/order.ts:781](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L781) ___ -### validateFulfillmentLineItem\_ +### validateFulfillmentLineItem -▸ **validateFulfillmentLineItem_**(`item`, `quantity`): `LineItem` +▸ `Protected` **validateFulfillmentLineItem**(`item`, `quantity`): ``null`` \| `LineItem` + +Checks that a given quantity of a line item can be fulfilled. Fails if the +fulfillable quantity is lower than the requested fulfillment quantity. +Fulfillable quantity is calculated by subtracting the already fulfilled +quantity from the quantity that was originally purchased. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `item` | `LineItem` | | -| `quantity` | `number` | | +| `item` | `LineItem` | the line item to check has sufficient fulfillable quantity. | +| `quantity` | `number` | the quantity that is requested to be fulfilled. | #### Returns -`LineItem` +``null`` \| `LineItem` + +a line item that has the requested fulfillment quantity + set. #### Defined in -[services/order.js:1091](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L1091) - -___ - -### validateId\_ - -▸ **validateId_**(`rawId`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `rawId` | `string` | | - -#### Returns - -`string` - -#### Defined in - -[services/order.js:139](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L139) +[packages/medusa/src/services/order.ts:1113](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/order.ts#L1113) ___ ### withTransaction -▸ **withTransaction**(`manager`): [`OrderService`](OrderService.md) +▸ **withTransaction**(`transactionManager?`): [`OrderService`](OrderService.md) #### Parameters | Name | Type | | :------ | :------ | -| `manager` | `any` | +| `transactionManager?` | `EntityManager` | #### Returns [`OrderService`](OrderService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[services/order.js:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/order.js#L102) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/PaymentProviderService.md b/docs/content/references/services/classes/PaymentProviderService.md index 2310bc4d96..b7b1558a8a 100644 --- a/docs/content/references/services/classes/PaymentProviderService.md +++ b/docs/content/references/services/classes/PaymentProviderService.md @@ -1,5 +1,7 @@ # Class: PaymentProviderService +Helps retrive payment providers + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +26,7 @@ BaseService.constructor #### Defined in -[services/payment-provider.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L8) +[packages/medusa/src/services/payment-provider.js:8](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L8) ## Properties @@ -34,7 +36,7 @@ BaseService.constructor #### Defined in -[services/payment-provider.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L14) +[packages/medusa/src/services/payment-provider.js:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L14) ___ @@ -44,7 +46,7 @@ ___ #### Defined in -[services/payment-provider.js:18](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L18) +[packages/medusa/src/services/payment-provider.js:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L18) ___ @@ -54,7 +56,7 @@ ___ #### Defined in -[services/payment-provider.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L16) +[packages/medusa/src/services/payment-provider.js:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L16) ___ @@ -64,7 +66,7 @@ ___ #### Defined in -[services/payment-provider.js:20](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L20) +[packages/medusa/src/services/payment-provider.js:20](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L20) ## Methods @@ -85,7 +87,7 @@ ___ #### Defined in -[services/payment-provider.js:283](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L283) +[packages/medusa/src/services/payment-provider.js:283](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L283) ___ @@ -105,7 +107,7 @@ ___ #### Defined in -[services/payment-provider.js:324](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L324) +[packages/medusa/src/services/payment-provider.js:324](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L324) ___ @@ -125,7 +127,7 @@ ___ #### Defined in -[services/payment-provider.js:343](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L343) +[packages/medusa/src/services/payment-provider.js:343](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L343) ___ @@ -145,7 +147,7 @@ ___ #### Defined in -[services/payment-provider.js:246](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L246) +[packages/medusa/src/services/payment-provider.js:246](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L246) ___ @@ -153,20 +155,24 @@ ___ ▸ **createSession**(`providerId`, `cart`): `Promise`<`any`\> +Creates a payment session with the given provider. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `providerId` | `string` | | -| `cart` | `Cart` | | +| `providerId` | `string` | the id of the provider to create payment with | +| `cart` | `Cart` | a cart object used to calculate the amount, etc. from | #### Returns `Promise`<`any`\> +the payment session + #### Defined in -[services/payment-provider.js:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L121) +[packages/medusa/src/services/payment-provider.js:121](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L121) ___ @@ -186,7 +192,7 @@ ___ #### Defined in -[services/payment-provider.js:202](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L202) +[packages/medusa/src/services/payment-provider.js:202](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L202) ___ @@ -206,7 +212,7 @@ ___ #### Defined in -[services/payment-provider.js:338](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L338) +[packages/medusa/src/services/payment-provider.js:338](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L338) ___ @@ -220,7 +226,7 @@ ___ #### Defined in -[services/payment-provider.js:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L47) +[packages/medusa/src/services/payment-provider.js:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L47) ___ @@ -245,7 +251,7 @@ ___ #### Defined in -[services/payment-provider.js:80](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L80) +[packages/medusa/src/services/payment-provider.js:80](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L80) ___ @@ -253,20 +259,25 @@ ___ ▸ **refreshSession**(`paymentSession`, `cart`): `Promise`<`any`\> +Refreshes a payment session with the given provider. +This means, that we delete the current one and create a new. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `paymentSession` | `PaymentSession` | | -| `cart` | `Cart` | | +| `paymentSession` | `PaymentSession` | the payment session object to update | +| `cart` | `Cart` | a cart object used to calculate the amount, etc. from | #### Returns `Promise`<`any`\> +the payment session + #### Defined in -[services/payment-provider.js:152](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L152) +[packages/medusa/src/services/payment-provider.js:152](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L152) ___ @@ -289,7 +300,7 @@ ___ #### Defined in -[services/payment-provider.js:358](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L358) +[packages/medusa/src/services/payment-provider.js:358](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L358) ___ @@ -309,7 +320,7 @@ ___ #### Defined in -[services/payment-provider.js:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L35) +[packages/medusa/src/services/payment-provider.js:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L35) ___ @@ -330,7 +341,7 @@ ___ #### Defined in -[services/payment-provider.js:54](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L54) +[packages/medusa/src/services/payment-provider.js:54](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L54) ___ @@ -338,19 +349,23 @@ ___ ▸ **retrieveProvider**(`providerId`): `PaymentService` +Finds a provider given an id + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `providerId` | `string` | | +| `providerId` | `string` | the id of the provider to get | #### Returns `PaymentService` +the payment provider + #### Defined in -[services/payment-provider.js:228](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L228) +[packages/medusa/src/services/payment-provider.js:228](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L228) ___ @@ -371,7 +386,7 @@ ___ #### Defined in -[services/payment-provider.js:422](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L422) +[packages/medusa/src/services/payment-provider.js:422](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L422) ___ @@ -392,7 +407,7 @@ ___ #### Defined in -[services/payment-provider.js:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L89) +[packages/medusa/src/services/payment-provider.js:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L89) ___ @@ -413,7 +428,7 @@ ___ #### Defined in -[services/payment-provider.js:266](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L266) +[packages/medusa/src/services/payment-provider.js:266](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L266) ___ @@ -421,20 +436,24 @@ ___ ▸ **updateSession**(`paymentSession`, `cart`): `Promise`<`any`\> +Updates an existing payment session. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `paymentSession` | `PaymentSession` | | -| `cart` | `Cart` | | +| `paymentSession` | `PaymentSession` | the payment session object to update | +| `cart` | `Cart` | the cart object to update for | #### Returns `Promise`<`any`\> +the updated payment session + #### Defined in -[services/payment-provider.js:188](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L188) +[packages/medusa/src/services/payment-provider.js:188](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L188) ___ @@ -455,7 +474,7 @@ ___ #### Defined in -[services/payment-provider.js:308](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L308) +[packages/medusa/src/services/payment-provider.js:308](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L308) ___ @@ -475,4 +494,4 @@ ___ #### Defined in -[services/payment-provider.js:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/payment-provider.js#L23) +[packages/medusa/src/services/payment-provider.js:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/payment-provider.js#L23) diff --git a/docs/content/references/services/classes/PricingService.md b/docs/content/references/services/classes/PricingService.md index 6ae69dd080..ce0ea4071c 100644 --- a/docs/content/references/services/classes/PricingService.md +++ b/docs/content/references/services/classes/PricingService.md @@ -1,5 +1,7 @@ # Class: PricingService +Allows retrieval of prices. + ## Hierarchy - `TransactionBaseService`<[`PricingService`](PricingService.md)\> @@ -24,7 +26,7 @@ TransactionBaseService<PricingService\>.constructor #### Defined in -[services/pricing.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L40) +[packages/medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L40) ## Properties @@ -36,6 +38,10 @@ TransactionBaseService<PricingService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +52,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### manager\_ @@ -58,7 +68,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/pricing.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L33) +[packages/medusa/src/services/pricing.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L33) ___ @@ -68,7 +78,7 @@ ___ #### Defined in -[services/pricing.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L37) +[packages/medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L37) ___ @@ -78,7 +88,7 @@ ___ #### Defined in -[services/pricing.ts:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L38) +[packages/medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L38) ___ @@ -88,7 +98,7 @@ ___ #### Defined in -[services/pricing.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L35) +[packages/medusa/src/services/pricing.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L35) ___ @@ -98,7 +108,7 @@ ___ #### Defined in -[services/pricing.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L36) +[packages/medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L36) ___ @@ -112,7 +122,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/pricing.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L34) +[packages/medusa/src/services/pricing.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L34) ## Methods @@ -120,6 +130,10 @@ TransactionBaseService.transactionManager\_ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -131,21 +145,23 @@ TransactionBaseService.transactionManager\_ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -153,20 +169,24 @@ ___ ▸ **calculateTaxes**(`variantPricing`, `productRates`): `Promise`<`TaxedPricing`\> +Gets the prices for a product variant + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantPricing` | `ProductVariantPricing` | | -| `productRates` | `TaxServiceRate`[] | | +| `variantPricing` | `ProductVariantPricing` | the prices retrieved from a variant | +| `productRates` | `TaxServiceRate`[] | the tax rates that the product has applied | #### Returns `Promise`<`TaxedPricing`\> +The tax related variant prices. + #### Defined in -[services/pricing.ts:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L102) +[packages/medusa/src/services/pricing.ts:98](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L98) ___ @@ -174,19 +194,24 @@ ___ ▸ **collectPricingContext**(`context`): `Promise`<`PricingContext`\> +Collects additional information neccessary for completing the price +selection. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `context` | `PriceSelectionContext` | | +| `context` | `PriceSelectionContext` | the price selection context to use | #### Returns `Promise`<`PricingContext`\> +The pricing context + #### Defined in -[services/pricing.ts:63](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L63) +[packages/medusa/src/services/pricing.ts:63](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L63) ___ @@ -194,20 +219,25 @@ ___ ▸ **getProductPricing**(`product`, `context`): `Promise`<`Record`<`string`, `ProductVariantPricing`\>\> +Gets all the variant prices for a product. All the product's variants will +be fetched. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `product` | `Pick`<`Product`, ``"id"`` \| ``"variants"``\> | | -| `context` | `PriceSelectionContext` | | +| `product` | `Pick`<`Product`, ``"id"`` \| ``"variants"``\> | the product to get pricing for. | +| `context` | `PriceSelectionContext` | the price selection context to use | #### Returns `Promise`<`Record`<`string`, `ProductVariantPricing`\>\> +A map of variant ids to their corresponding prices + #### Defined in -[services/pricing.ts:292](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L292) +[packages/medusa/src/services/pricing.ts:286](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L286) ___ @@ -215,20 +245,24 @@ ___ ▸ **getProductPricingById**(`productId`, `context`): `Promise`<`Record`<`string`, `ProductVariantPricing`\>\> +Gets all the variant prices for a product by the product id + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `context` | `PriceSelectionContext` | | +| `productId` | `string` | the id of the product to get prices for | +| `context` | `PriceSelectionContext` | the price selection context to use | #### Returns `Promise`<`Record`<`string`, `ProductVariantPricing`\>\> +A map of variant ids to their corresponding prices + #### Defined in -[services/pricing.ts:310](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L310) +[packages/medusa/src/services/pricing.ts:304](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L304) ___ @@ -250,7 +284,7 @@ ___ #### Defined in -[services/pricing.ts:254](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L254) +[packages/medusa/src/services/pricing.ts:248](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L248) ___ @@ -258,20 +292,24 @@ ___ ▸ **getProductVariantPricing**(`variant`, `context`): `Promise`<`ProductVariantPricing`\> +Gets the prices for a product variant. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variant` | `Pick`<`ProductVariant`, ``"id"`` \| ``"product_id"``\> | | -| `context` | `PriceSelectionContext` \| `PricingContext` | | +| `variant` | `Pick`<`ProductVariant`, ``"id"`` \| ``"product_id"``\> | the id of the variant to get prices for | +| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use | #### Returns `Promise`<`ProductVariantPricing`\> +The product variant prices + #### Defined in -[services/pricing.ts:180](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L180) +[packages/medusa/src/services/pricing.ts:176](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L176) ___ @@ -279,20 +317,24 @@ ___ ▸ **getProductVariantPricingById**(`variantId`, `context`): `Promise`<`ProductVariantPricing`\> +Gets the prices for a product variant by a variant id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `context` | `PriceSelectionContext` \| `PricingContext` | | +| `variantId` | `string` | the id of the variant to get prices for | +| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use | #### Returns `Promise`<`ProductVariantPricing`\> +The product variant prices + #### Defined in -[services/pricing.ts:218](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L218) +[packages/medusa/src/services/pricing.ts:214](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L214) ___ @@ -314,7 +356,7 @@ ___ #### Defined in -[services/pricing.ts:138](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L138) +[packages/medusa/src/services/pricing.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L134) ___ @@ -322,20 +364,24 @@ ___ ▸ **getShippingOptionPricing**(`shippingOption`, `context`): `Promise`<`PricedShippingOption`\> +Gets the prices for a shipping option. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `shippingOption` | `ShippingOption` | | -| `context` | `PriceSelectionContext` \| `PricingContext` | | +| `shippingOption` | `ShippingOption` | the shipping option to get prices for | +| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use | #### Returns `Promise`<`PricedShippingOption`\> +The shipping option prices + #### Defined in -[services/pricing.ts:396](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L396) +[packages/medusa/src/services/pricing.ts:390](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L390) ___ @@ -343,20 +389,24 @@ ___ ▸ **setProductPrices**(`products`, `context?`): `Promise`<(`Product` \| `PricedProduct`)[]\> +Set additional prices on a list of products. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `products` | `Product`[] | | -| `context` | `PriceSelectionContext` | | +| `products` | `Product`[] | list of products on which to set additional prices | +| `context` | `PriceSelectionContext` | the price selection context to use | #### Returns `Promise`<(`Product` \| `PricedProduct`)[]\> +A list of products with variants decorated with prices + #### Defined in -[services/pricing.ts:353](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L353) +[packages/medusa/src/services/pricing.ts:347](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L347) ___ @@ -364,20 +414,24 @@ ___ ▸ **setShippingOptionPrices**(`shippingOptions`, `context?`): `Promise`<`PricedShippingOption`[]\> +Set additional prices on a list of shipping options. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `shippingOptions` | `ShippingOption`[] | | -| `context` | `Omit`<`PriceSelectionContext`, ``"region_id"``\> | | +| `shippingOptions` | `ShippingOption`[] | list of shipping options on which to set additional prices | +| `context` | `Omit`<`PriceSelectionContext`, ``"region_id"``\> | the price selection context to use | #### Returns `Promise`<`PricedShippingOption`[]\> +A list of shipping options with prices + #### Defined in -[services/pricing.ts:445](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L445) +[packages/medusa/src/services/pricing.ts:437](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L437) ___ @@ -385,20 +439,24 @@ ___ ▸ **setVariantPrices**(`variants`, `context`): `Promise`<`PricedVariant`[]\> +Set additional prices on a list of product variants. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variants` | `ProductVariant`[] | | -| `context` | `PriceSelectionContext` | | +| `variants` | `ProductVariant`[] | list of variants on which to set additional prices | +| `context` | `PriceSelectionContext` | the price selection context to use | #### Returns `Promise`<`PricedVariant`[]\> +A list of products with variants decorated with prices + #### Defined in -[services/pricing.ts:328](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/pricing.ts#L328) +[packages/medusa/src/services/pricing.ts:322](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/pricing.ts#L322) ___ @@ -422,7 +480,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -446,4 +504,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/ProductCollectionService.md b/docs/content/references/services/classes/ProductCollectionService.md index da3c13d33b..7650536b81 100644 --- a/docs/content/references/services/classes/ProductCollectionService.md +++ b/docs/content/references/services/classes/ProductCollectionService.md @@ -1,5 +1,7 @@ # Class: ProductCollectionService +Provides layer to manipulate product collections. + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +26,7 @@ BaseService.constructor #### Defined in -[services/product-collection.js:11](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L11) +[packages/medusa/src/services/product-collection.js:11](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L11) ## Methods @@ -45,7 +47,7 @@ BaseService.constructor #### Defined in -[services/product-collection.js:170](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L170) +[packages/medusa/src/services/product-collection.js:170](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L170) ___ @@ -53,19 +55,23 @@ ___ ▸ **create**(`collection`): `Promise`<`ProductCollection`\> +Creates a product collection + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `collection` | `any` | | +| `collection` | `any` | the collection to create | #### Returns `Promise`<`ProductCollection`\> +created collection + #### Defined in -[services/product-collection.js:104](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L104) +[packages/medusa/src/services/product-collection.js:104](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L104) ___ @@ -73,19 +79,23 @@ ___ ▸ **delete**(`collectionId`): `Promise`<`any`\> +Deletes a product collection idempotently + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `collectionId` | `string` | | +| `collectionId` | `string` | id of collection to delete | #### Returns `Promise`<`any`\> +empty promise + #### Defined in -[services/product-collection.js:152](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L152) +[packages/medusa/src/services/product-collection.js:152](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L152) ___ @@ -93,20 +103,24 @@ ___ ▸ **list**(`selector?`, `config?`): `Promise`<`any`\> +Lists product collections + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `selector` | `any` | the query object for find | +| `config` | `any` | the config to be used for find | #### Returns `Promise`<`any`\> +the result of the find operation + #### Defined in -[services/product-collection.js:206](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L206) +[packages/medusa/src/services/product-collection.js:206](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L206) ___ @@ -114,20 +128,24 @@ ___ ▸ **listAndCount**(`selector?`, `config?`): `Promise`<`any`\> +Lists product collections and add count. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `selector` | `any` | the query object for find | +| `config` | `any` | the config to be used for find | #### Returns `Promise`<`any`\> +the result of the find operation + #### Defined in -[services/product-collection.js:221](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L221) +[packages/medusa/src/services/product-collection.js:221](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L221) ___ @@ -148,7 +166,7 @@ ___ #### Defined in -[services/product-collection.js:188](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L188) +[packages/medusa/src/services/product-collection.js:188](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L188) ___ @@ -156,20 +174,24 @@ ___ ▸ **retrieve**(`collectionId`, `config?`): `Promise`<`ProductCollection`\> +Retrieves a product collection by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `collectionId` | `string` | | -| `config` | `any` | | +| `collectionId` | `string` | the id of the collection to retrieve. | +| `config` | `any` | the config of the collection to retrieve. | #### Returns `Promise`<`ProductCollection`\> +the collection. + #### Defined in -[services/product-collection.js:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L55) +[packages/medusa/src/services/product-collection.js:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L55) ___ @@ -177,20 +199,24 @@ ___ ▸ **retrieveByHandle**(`collectionHandle`, `config?`): `Promise`<`ProductCollection`\> +Retrieves a product collection by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `collectionHandle` | `string` | | -| `config` | `any` | | +| `collectionHandle` | `string` | the handle of the collection to retrieve. | +| `config` | `any` | query config for request | #### Returns `Promise`<`ProductCollection`\> +the collection. + #### Defined in -[services/product-collection.js:81](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L81) +[packages/medusa/src/services/product-collection.js:81](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L81) ___ @@ -198,20 +224,24 @@ ___ ▸ **update**(`collectionId`, `update`): `Promise`<`ProductCollection`\> +Updates a product collection + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `collectionId` | `string` | | -| `update` | `any` | | +| `collectionId` | `string` | id of collection to update | +| `update` | `any` | update object | #### Returns `Promise`<`ProductCollection`\> +update collection + #### Defined in -[services/product-collection.js:125](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L125) +[packages/medusa/src/services/product-collection.js:125](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L125) ___ @@ -231,4 +261,4 @@ ___ #### Defined in -[services/product-collection.js:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L32) +[packages/medusa/src/services/product-collection.js:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L32) diff --git a/docs/content/references/services/classes/ProductService.md b/docs/content/references/services/classes/ProductService.md index b3470bdfdb..d2f86a8d8f 100644 --- a/docs/content/references/services/classes/ProductService.md +++ b/docs/content/references/services/classes/ProductService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `TransactionBaseService`<[`ProductService`](ProductService.md)\> +- `TransactionBaseService`<[`ProductService`](ProductService.md), `InjectedDependencies`\> ↳ **`ProductService`** @@ -20,11 +20,14 @@ #### Overrides -TransactionBaseService<ProductService\>.constructor +TransactionBaseService< + ProductService, + InjectedDependencies +\>.constructor #### Defined in -[services/product.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L62) +[packages/medusa/src/services/product.ts:75](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L75) ## Properties @@ -36,16 +39,24 @@ TransactionBaseService<ProductService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container -• `Protected` `Readonly` **container**: `unknown` +• `Protected` `Readonly` **container**: `InjectedDependencies` #### Inherited from TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### eventBus\_ @@ -54,7 +65,17 @@ ___ #### Defined in -[services/product.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L53) +[packages/medusa/src/services/product.ts:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L65) + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter` + +#### Defined in + +[packages/medusa/src/services/product.ts:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L66) ___ @@ -64,7 +85,7 @@ ___ #### Defined in -[services/product.ts:50](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L50) +[packages/medusa/src/services/product.ts:62](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L62) ___ @@ -78,7 +99,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/product.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L42) +[packages/medusa/src/services/product.ts:54](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L54) ___ @@ -88,7 +109,7 @@ ___ #### Defined in -[services/product.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L45) +[packages/medusa/src/services/product.ts:57](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L57) ___ @@ -98,7 +119,7 @@ ___ #### Defined in -[services/product.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L46) +[packages/medusa/src/services/product.ts:58](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L58) ___ @@ -108,7 +129,7 @@ ___ #### Defined in -[services/product.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L49) +[packages/medusa/src/services/product.ts:61](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L61) ___ @@ -118,7 +139,7 @@ ___ #### Defined in -[services/product.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L48) +[packages/medusa/src/services/product.ts:60](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L60) ___ @@ -128,7 +149,7 @@ ___ #### Defined in -[services/product.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L47) +[packages/medusa/src/services/product.ts:59](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L59) ___ @@ -138,7 +159,7 @@ ___ #### Defined in -[services/product.ts:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L51) +[packages/medusa/src/services/product.ts:63](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L63) ___ @@ -148,7 +169,7 @@ ___ #### Defined in -[services/product.ts:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L52) +[packages/medusa/src/services/product.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L64) ___ @@ -162,7 +183,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/product.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L43) +[packages/medusa/src/services/product.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L55) ___ @@ -180,7 +201,7 @@ ___ #### Defined in -[services/product.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L56) +[packages/medusa/src/services/product.ts:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L69) ___ @@ -190,7 +211,7 @@ ___ #### Defined in -[services/product.ts:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L55) +[packages/medusa/src/services/product.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L68) ## Methods @@ -198,20 +219,26 @@ ___ ▸ **addOption**(`productId`, `optionTitle`): `Promise`<`Product`\> +Adds an option to a product. Options can, for example, be "Size", "Color", +etc. Will update all the products variants with a dummy value for the newly +created option. The same option cannot be added more than once. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `optionTitle` | `string` | | +| `productId` | `string` | the product to apply the new option to | +| `optionTitle` | `string` | the display title of the option, e.g. "Size" | #### Returns `Promise`<`Product`\> +the result of the model update operation + #### Defined in -[services/product.ts:552](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L552) +[packages/medusa/src/services/product.ts:637](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L637) ___ @@ -219,6 +246,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -230,21 +261,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -252,19 +285,23 @@ ___ ▸ **count**(`selector?`): `Promise`<`number`\> +Return the total number of documents in database + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`Product`\> | | +| `selector` | `Selector`<`Product`\> | the selector to choose products by | #### Returns `Promise`<`number`\> +the result of the count operation + #### Defined in -[services/product.ts:175](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L175) +[packages/medusa/src/services/product.ts:178](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L178) ___ @@ -272,19 +309,23 @@ ___ ▸ **create**(`productObject`): `Promise`<`Product`\> +Creates a product. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productObject` | `CreateProductInput` | | +| `productObject` | `CreateProductInput` | the product to create | #### Returns `Promise`<`Product`\> +resolves to the creation result. + #### Defined in -[services/product.ts:324](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L324) +[packages/medusa/src/services/product.ts:346](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L346) ___ @@ -292,19 +333,24 @@ ___ ▸ **delete**(`productId`): `Promise`<`void`\> +Deletes a product from a given product id. The product's associated +variants will also be deleted. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | +| `productId` | `string` | the id of the product to delete. Must be castable as an ObjectId | #### Returns `Promise`<`void`\> +empty promise + #### Defined in -[services/product.ts:518](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L518) +[packages/medusa/src/services/product.ts:603](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L603) ___ @@ -312,33 +358,38 @@ ___ ▸ **deleteOption**(`productId`, `optionId`): `Promise`<`void` \| `Product`\> +Delete an option from a product. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `optionId` | `string` | | +| `productId` | `string` | the product to delete an option from | +| `optionId` | `string` | the option to delete | #### Returns `Promise`<`void` \| `Product`\> +the updated product + #### Defined in -[services/product.ts:693](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L693) +[packages/medusa/src/services/product.ts:778](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L778) ___ -### list +### filterProductsBySalesChannel -▸ **list**(`selector?`, `config?`): `Promise`<`Product`[]\> +▸ **filterProductsBySalesChannel**(`productIds`, `salesChannelId`, `config?`): `Promise`<`Product`[]\> #### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | -| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | | -| `config` | `FindProductConfig` | | +| Name | Type | +| :------ | :------ | +| `productIds` | `string`[] | +| `salesChannelId` | `string` | +| `config` | `FindProductConfig` | #### Returns @@ -346,7 +397,32 @@ ___ #### Defined in -[services/product.ts:107](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L107) +[packages/medusa/src/services/product.ts:292](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L292) + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<`Product`[]\> + +Lists products based on the provided parameters. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | an object that defines rules to filter products by | +| `config` | `FindProductConfig` | object that defines the scope for what should be returned | + +#### Returns + +`Promise`<`Product`[]\> + +the result of the find operation + +#### Defined in + +[packages/medusa/src/services/product.ts:112](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L112) ___ @@ -354,20 +430,27 @@ ___ ▸ **listAndCount**(`selector`, `config?`): `Promise`<[`Product`[], `number`]\> +Lists products based on the provided parameters and includes the count of +products that match the query. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | | -| `config` | `FindProductConfig` | | +| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | an object that defines rules to filter products by | +| `config` | `FindProductConfig` | object that defines the scope for what should be returned | #### Returns `Promise`<[`Product`[], `number`]\> +an array containing the products as + the first element and the total count of products that matches the query + as the second element. + #### Defined in -[services/product.ts:144](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L144) +[packages/medusa/src/services/product.ts:148](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L148) ___ @@ -387,7 +470,7 @@ ___ #### Defined in -[services/product.ts:309](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L309) +[packages/medusa/src/services/product.ts:332](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L332) ___ @@ -401,7 +484,7 @@ ___ #### Defined in -[services/product.ts:299](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L299) +[packages/medusa/src/services/product.ts:323](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L323) ___ @@ -409,17 +492,22 @@ ___ ▸ `Protected` **prepareListQuery_**(`selector`, `config`): `Object` +Creates a query object to be used for list queries. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | | -| `config` | `FindProductConfig` | | +| `selector` | `Selector`<`Product`\> \| `FilterableProductProps` | the selector to create the query from | +| `config` | `FindProductConfig` | the config to use for the query | #### Returns `Object` +an object containing the query, relations and free-text + search param. + | Name | Type | | :------ | :------ | | `q` | `string` | @@ -428,7 +516,7 @@ ___ #### Defined in -[services/product.ts:759](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L759) +[packages/medusa/src/services/product.ts:844](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L844) ___ @@ -449,7 +537,7 @@ ___ #### Defined in -[services/product.ts:591](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L591) +[packages/medusa/src/services/product.ts:676](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L676) ___ @@ -457,20 +545,25 @@ ___ ▸ **retrieve**(`productId`, `config?`): `Promise`<`Product`\> +Gets a product by id. +Throws in case of DB Error and if product was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `config` | `FindProductConfig` | | +| `productId` | `string` | id of the product to get. | +| `config` | `FindProductConfig` | object that defines what should be included in the query response | #### Returns `Promise`<`Product`\> +the result of the find one operation. + #### Defined in -[services/product.ts:191](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L191) +[packages/medusa/src/services/product.ts:193](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L193) ___ @@ -478,20 +571,25 @@ ___ ▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<`Product`\> +Gets a product by external id. +Throws in case of DB Error and if product was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `externalId` | `string` | | -| `config` | `FindProductConfig` | | +| `externalId` | `string` | handle of the product to get. | +| `config` | `FindProductConfig` | details about what to get from the product | #### Returns `Promise`<`Product`\> +the result of the find one operation. + #### Defined in -[services/product.ts:225](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L225) +[packages/medusa/src/services/product.ts:223](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L223) ___ @@ -499,20 +597,25 @@ ___ ▸ **retrieveByHandle**(`productHandle`, `config?`): `Promise`<`Product`\> +Gets a product by handle. +Throws in case of DB Error and if product was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productHandle` | `string` | | -| `config` | `FindProductConfig` | | +| `productHandle` | `string` | handle of the product to get. | +| `config` | `FindProductConfig` | details about what to get from the product | #### Returns `Promise`<`Product`\> +the result of the find one operation. + #### Defined in -[services/product.ts:209](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L209) +[packages/medusa/src/services/product.ts:209](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L209) ___ @@ -520,20 +623,24 @@ ___ ▸ **retrieveVariants**(`productId`, `config?`): `Promise`<`ProductVariant`[]\> +Gets all variants belonging to a product. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `config` | `FindProductConfig` | | +| `productId` | `string` | the id of the product to get variants from. | +| `config` | `FindProductConfig` | The config to select and configure relations etc... | #### Returns `Promise`<`ProductVariant`[]\> +an array of variants + #### Defined in -[services/product.ts:279](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L279) +[packages/medusa/src/services/product.ts:274](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L274) ___ @@ -541,20 +648,25 @@ ___ ▸ **retrieve_**(`selector`, `config?`): `Promise`<`Product`\> +Gets a product by selector. +Throws in case of DB Error and if product was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`Product`\> | | -| `config` | `FindProductConfig` | | +| `selector` | `Selector`<`Product`\> | selector object | +| `config` | `FindProductConfig` | object that defines what should be included in the query response | #### Returns `Promise`<`Product`\> +the result of the find one operation. + #### Defined in -[services/product.ts:242](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L242) +[packages/medusa/src/services/product.ts:238](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L238) ___ @@ -578,7 +690,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -586,20 +698,26 @@ ___ ▸ **update**(`productId`, `update`): `Promise`<`Product`\> +Updates a product. Product variant updates should use dedicated methods, +e.g. `addVariant`, etc. The function will throw errors if metadata or +product variant updates are attempted. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `update` | `UpdateProductInput` | | +| `productId` | `string` | the id of the product. Must be a string that can be casted to an ObjectId | +| `update` | `UpdateProductInput` | an object with the update values. | #### Returns `Promise`<`Product`\> +resolves to the update result. + #### Defined in -[services/product.ts:399](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L399) +[packages/medusa/src/services/product.ts:445](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L445) ___ @@ -607,21 +725,26 @@ ___ ▸ **updateOption**(`productId`, `optionId`, `data`): `Promise`<`Product`\> +Updates a product's option. Throws if the call tries to update an option +not associated with the product. Throws if the updated title already exists. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `optionId` | `string` | | -| `data` | `ProductOptionInput` | | +| `productId` | `string` | the product whose option we are updating | +| `optionId` | `string` | the id of the option we are updating | +| `data` | `ProductOptionInput` | the data to update the option with | #### Returns `Promise`<`Product`\> +the updated product + #### Defined in -[services/product.ts:637](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product.ts#L637) +[packages/medusa/src/services/product.ts:722](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product.ts#L722) ___ @@ -645,4 +768,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/ProductTypeService.md b/docs/content/references/services/classes/ProductTypeService.md index 75819a215e..ecb308ba9b 100644 --- a/docs/content/references/services/classes/ProductTypeService.md +++ b/docs/content/references/services/classes/ProductTypeService.md @@ -1,5 +1,7 @@ # Class: ProductTypeService +Provides layer to manipulate products. + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +26,7 @@ BaseService.constructor #### Defined in -[services/product-type.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L16) +[packages/medusa/src/services/product-type.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L16) ## Properties @@ -34,7 +36,7 @@ BaseService.constructor #### Defined in -[services/product-type.ts:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L14) +[packages/medusa/src/services/product-type.ts:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L14) ___ @@ -44,7 +46,7 @@ ___ #### Defined in -[services/product-type.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L15) +[packages/medusa/src/services/product-type.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L15) ## Methods @@ -52,20 +54,24 @@ ___ ▸ **list**(`selector?`, `config?`): `Promise`<`ProductType`[]\> +Lists product types + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableProductTypeProps` | | -| `config` | `FindConfig`<`ProductType`\> | | +| `selector` | `FilterableProductTypeProps` | the query object for find | +| `config` | `FindConfig`<`ProductType`\> | the config to be used for find | #### Returns `Promise`<`ProductType`[]\> +the result of the find operation + #### Defined in -[services/product-type.ts:72](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L72) +[packages/medusa/src/services/product-type.ts:72](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L72) ___ @@ -73,20 +79,24 @@ ___ ▸ **listAndCount**(`selector?`, `config?`): `Promise`<[`ProductType`[], `number`]\> +Lists product tags and adds count. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableProductTypeProps` | | -| `config` | `FindConfig`<`ProductType`\> | | +| `selector` | `FilterableProductTypeProps` | the query object for find | +| `config` | `FindConfig`<`ProductType`\> | the config to be used for find | #### Returns `Promise`<[`ProductType`[], `number`]\> +the result of the find operation + #### Defined in -[services/product-type.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L88) +[packages/medusa/src/services/product-type.ts:88](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L88) ___ @@ -94,20 +104,25 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`ProductType`\> +Gets a product by id. +Throws in case of DB Error and if product was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `FindConfig`<`ProductType`\> | | +| `id` | `string` | id of the product to get. | +| `config` | `FindConfig`<`ProductType`\> | object that defines what should be included in the query response | #### Returns `Promise`<`ProductType`\> +the result of the find one operation. + #### Defined in -[services/product-type.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L47) +[packages/medusa/src/services/product-type.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L47) ___ @@ -127,4 +142,4 @@ ___ #### Defined in -[services/product-type.ts:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-type.ts#L23) +[packages/medusa/src/services/product-type.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-type.ts#L23) diff --git a/docs/content/references/services/classes/ProductVariantService.md b/docs/content/references/services/classes/ProductVariantService.md index de25d60e29..e1e95ba037 100644 --- a/docs/content/references/services/classes/ProductVariantService.md +++ b/docs/content/references/services/classes/ProductVariantService.md @@ -1,5 +1,7 @@ # Class: ProductVariantService +Provides layer to manipulate product variants. + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +26,7 @@ BaseService.constructor #### Defined in -[services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L52) +[packages/medusa/src/services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L52) ## Properties @@ -34,7 +36,7 @@ BaseService.constructor #### Defined in -[services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L50) +[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L50) ___ @@ -44,7 +46,7 @@ ___ #### Defined in -[services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L45) +[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L45) ___ @@ -54,7 +56,7 @@ ___ #### Defined in -[services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L42) +[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L42) ___ @@ -64,7 +66,7 @@ ___ #### Defined in -[services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L48) +[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L48) ___ @@ -74,7 +76,7 @@ ___ #### Defined in -[services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L47) +[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L47) ___ @@ -84,7 +86,7 @@ ___ #### Defined in -[services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L49) +[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L49) ___ @@ -94,7 +96,7 @@ ___ #### Defined in -[services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L44) +[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L44) ___ @@ -104,7 +106,7 @@ ___ #### Defined in -[services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L43) +[packages/medusa/src/services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L43) ___ @@ -114,7 +116,7 @@ ___ #### Defined in -[services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L46) +[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L46) ___ @@ -132,7 +134,7 @@ ___ #### Defined in -[services/product-variant.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L36) +[packages/medusa/src/services/product-variant.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L36) ## Methods @@ -140,21 +142,29 @@ ___ ▸ **addOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<`ProductOptionValue`\> +Adds option value to a varaint. +Fails when product with variant does not exists or +if that product does not have an option with the given +option id. Fails if given variant is not found. +Option value must be of type string or number. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `optionId` | `string` | | -| `optionValue` | `string` | | +| `variantId` | `string` | the variant to decorate. | +| `optionId` | `string` | the option from product. | +| `optionValue` | `string` | option value to add. | #### Returns `Promise`<`ProductOptionValue`\> +the result of the update operation. + #### Defined in -[services/product-variant.ts:529](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L529) +[packages/medusa/src/services/product-variant.ts:529](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L529) ___ @@ -162,20 +172,25 @@ ___ ▸ **create**(`productOrProductId`, `variant`): `Promise`<`ProductVariant`\> +Creates an unpublished product variant. Will validate against parent product +to ensure that the variant can in fact be created. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productOrProductId` | `string` \| `Product` | | -| `variant` | `CreateProductVariantInput` | | +| `productOrProductId` | `string` \| `Product` | the product the variant will be added to | +| `variant` | `CreateProductVariantInput` | the variant to create | #### Returns `Promise`<`ProductVariant`\> +resolves to the creation result. + #### Defined in -[services/product-variant.ts:183](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L183) +[packages/medusa/src/services/product-variant.ts:183](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L183) ___ @@ -183,19 +198,24 @@ ___ ▸ **delete**(`variantId`): `Promise`<`void`\> +Deletes variant. +Will never fail due to delete being idempotent. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | +| `variantId` | `string` | the id of the variant to delete. Must be castable as an ObjectId | #### Returns `Promise`<`void`\> +empty promise + #### Defined in -[services/product-variant.ts:682](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L682) +[packages/medusa/src/services/product-variant.ts:682](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L682) ___ @@ -203,20 +223,25 @@ ___ ▸ **deleteOptionValue**(`variantId`, `optionId`): `Promise`<`void`\> +Deletes option value from given variant. +Will never fail due to delete being idempotent. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `optionId` | `string` | | +| `variantId` | `string` | the variant to decorate. | +| `optionId` | `string` | the option from product. | #### Returns `Promise`<`void`\> +empty promise + #### Defined in -[services/product-variant.ts:556](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L556) +[packages/medusa/src/services/product-variant.ts:556](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L556) ___ @@ -224,21 +249,27 @@ ___ ▸ **getFreeTextQueryBuilder_**(`variantRepo`, `query`, `q?`): `SelectQueryBuilder`<`ProductVariant`\> +Lists variants based on the provided parameters and includes the count of +variants that match the query. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantRepo` | `ProductVariantRepository` | | -| `query` | `FindWithRelationsOptions` | | -| `q?` | `string` | | +| `variantRepo` | `ProductVariantRepository` | the variant repository | +| `query` | `FindWithRelationsOptions` | object that defines the scope for what should be returned | +| `q?` | `string` | free text query | #### Returns `SelectQueryBuilder`<`ProductVariant`\> +an array containing the products as the first element and the total + count of products that matches the query as the second element. + #### Defined in -[services/product-variant.ts:788](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L788) +[packages/medusa/src/services/product-variant.ts:788](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L788) ___ @@ -246,20 +277,26 @@ ___ ▸ **getRegionPrice**(`variantId`, `context`): `Promise`<`number`\> +Gets the price specific to a region. If no region specific money amount +exists the function will try to use a currency price. If no default +currency price exists the function will throw an error. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `context` | `GetRegionPriceContext` | | +| `variantId` | `string` | the id of the variant to get price from | +| `context` | `GetRegionPriceContext` | context for getting region price | #### Returns `Promise`<`number`\> +the price specific to the region + #### Defined in -[services/product-variant.ts:404](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L404) +[packages/medusa/src/services/product-variant.ts:404](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L404) ___ @@ -271,16 +308,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableProductVariantProps` | | -| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | | +| `selector` | `FilterableProductVariantProps` | the query object for find | +| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval | #### Returns `Promise`<`ProductVariant`[]\> +the result of the find operation + #### Defined in -[services/product-variant.ts:624](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L624) +[packages/medusa/src/services/product-variant.ts:624](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L624) ___ @@ -292,16 +331,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableProductVariantProps` | | -| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | | +| `selector` | `FilterableProductVariantProps` | the query object for find | +| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval | #### Returns `Promise`<[`ProductVariant`[], `number`]\> +the result of the find operation + #### Defined in -[services/product-variant.ts:583](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L583) +[packages/medusa/src/services/product-variant.ts:583](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L583) ___ @@ -309,17 +350,22 @@ ___ ▸ **prepareListQuery_**(`selector`, `config`): `Object` +Creates a query object to be used for list queries. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableProductVariantProps` | | -| `config` | `FindConfig`<`ProductVariant`\> | | +| `selector` | `FilterableProductVariantProps` | the selector to create the query from | +| `config` | `FindConfig`<`ProductVariant`\> | the config to use for the query | #### Returns `Object` +an object containing the query, relations and free-text + search param. + | Name | Type | | :------ | :------ | | `q?` | `string` | @@ -328,7 +374,7 @@ ___ #### Defined in -[services/product-variant.ts:749](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L749) +[packages/medusa/src/services/product-variant.ts:749](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L749) ___ @@ -336,20 +382,24 @@ ___ ▸ **retrieve**(`variantId`, `config?`): `Promise`<`ProductVariant`\> +Gets a product variant by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | | +| `variantId` | `string` | the id of the product to get. | +| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval. | #### Returns `Promise`<`ProductVariant`\> +the product document. + #### Defined in -[services/product-variant.ts:117](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L117) +[packages/medusa/src/services/product-variant.ts:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L117) ___ @@ -357,20 +407,24 @@ ___ ▸ **retrieveBySKU**(`sku`, `config?`): `Promise`<`ProductVariant`\> +Gets a product variant by id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `sku` | `string` | | -| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | | +| `sku` | `string` | The unique stock keeping unit used to identify the product variant. | +| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval. | #### Returns `Promise`<`ProductVariant`\> +the product document. + #### Defined in -[services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L147) +[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L147) ___ @@ -378,20 +432,24 @@ ___ ▸ **setCurrencyPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\> +Sets the default price for the given currency. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `price` | `ProductVariantPrice` | | +| `variantId` | `string` | the id of the variant to set prices for | +| `price` | `ProductVariantPrice` | the price for the variant | #### Returns `Promise`<`MoneyAmount`\> +the result of the update operation + #### Defined in -[services/product-variant.ts:470](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L470) +[packages/medusa/src/services/product-variant.ts:470](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L470) ___ @@ -399,20 +457,24 @@ ___ ▸ **setMetadata_**(`variant`, `metadata`): `Record`<`string`, `unknown`\> +Dedicated method to set metadata for a variant. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variant` | `ProductVariant` | | -| `metadata` | `object` | | +| `variant` | `ProductVariant` | the variant to set metadata for. | +| `metadata` | `object` | the metadata to set | #### Returns `Record`<`string`, `unknown`\> +updated metadata object + #### Defined in -[services/product-variant.ts:717](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L717) +[packages/medusa/src/services/product-variant.ts:717](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L717) ___ @@ -420,20 +482,24 @@ ___ ▸ **setRegionPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\> +Sets the default price of a specific region + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `price` | `ProductVariantPrice` | | +| `variantId` | `string` | the id of the variant to update | +| `price` | `ProductVariantPrice` | the price for the variant. | #### Returns `Promise`<`MoneyAmount`\> +the result of the update operation + #### Defined in -[services/product-variant.ts:433](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L433) +[packages/medusa/src/services/product-variant.ts:433](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L433) ___ @@ -441,20 +507,26 @@ ___ ▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\> +Updates a variant. +Price updates should use dedicated methods. +The function will throw, if price updates are attempted. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantOrVariantId` | `string` \| `Partial`<`ProductVariant`\> | | -| `update` | `UpdateProductVariantInput` | | +| `variantOrVariantId` | `string` \| `Partial`<`ProductVariant`\> | variant or id of a variant. | +| `update` | `UpdateProductVariantInput` | an object with the update values. | #### Returns `Promise`<`ProductVariant`\> +resolves to the update result. + #### Defined in -[services/product-variant.ts:288](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L288) +[packages/medusa/src/services/product-variant.ts:288](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L288) ___ @@ -462,21 +534,26 @@ ___ ▸ **updateOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<`ProductOptionValue`\> +Updates variant's option value. +Option value must be of type string or number. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `optionId` | `string` | | -| `optionValue` | `string` | | +| `variantId` | `string` | the variant to decorate. | +| `optionId` | `string` | the option from product. | +| `optionValue` | `string` | option value to add. | #### Returns `Promise`<`ProductOptionValue`\> +the result of the update operation. + #### Defined in -[services/product-variant.ts:491](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L491) +[packages/medusa/src/services/product-variant.ts:491](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L491) ___ @@ -484,20 +561,25 @@ ___ ▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\> +Updates a variant's prices. +Deletes any prices that are not in the update object, and is not associated with a price list. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `variantId` | `string` | | -| `prices` | `ProductVariantPrice`[] | | +| `variantId` | `string` | the id of variant variant | +| `prices` | `ProductVariantPrice`[] | the update prices | #### Returns `Promise`<`void`\> +empty promise + #### Defined in -[services/product-variant.ts:366](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L366) +[packages/medusa/src/services/product-variant.ts:366](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L366) ___ @@ -517,4 +599,4 @@ ___ #### Defined in -[services/product-variant.ts:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L89) +[packages/medusa/src/services/product-variant.ts:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L89) diff --git a/docs/content/references/services/classes/QueryBuilderService.md b/docs/content/references/services/classes/QueryBuilderService.md index e69e452db6..53b6625823 100644 --- a/docs/content/references/services/classes/QueryBuilderService.md +++ b/docs/content/references/services/classes/QueryBuilderService.md @@ -34,7 +34,7 @@ BaseService.constructor #### Defined in -[services/query-builder.js:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/query-builder.js#L25) +[packages/medusa/src/services/query-builder.js:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/query-builder.js#L25) ___ @@ -55,7 +55,7 @@ ___ #### Defined in -[services/query-builder.js:5](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/query-builder.js#L5) +[packages/medusa/src/services/query-builder.js:5](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/query-builder.js#L5) ___ @@ -76,4 +76,4 @@ ___ #### Defined in -[services/query-builder.js:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/query-builder.js#L39) +[packages/medusa/src/services/query-builder.js:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/query-builder.js#L39) diff --git a/docs/content/references/services/classes/RegionService.md b/docs/content/references/services/classes/RegionService.md index 618353018f..124adf3988 100644 --- a/docs/content/references/services/classes/RegionService.md +++ b/docs/content/references/services/classes/RegionService.md @@ -1,5 +1,7 @@ # Class: RegionService +Provides layer to manipulate regions. + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +26,7 @@ BaseService.constructor #### Defined in -[services/region.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L16) +[packages/medusa/src/services/region.js:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L16) ## Properties @@ -42,7 +44,7 @@ BaseService.constructor #### Defined in -[services/region.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L10) +[packages/medusa/src/services/region.js:10](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L10) ## Methods @@ -50,20 +52,24 @@ BaseService.constructor ▸ **addCountry**(`regionId`, `code`): `Promise`<`any`\> +Adds a country to the region. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | -| `code` | `string` | | +| `regionId` | `string` | the region to add a country to | +| `code` | `string` | a 2 digit alphanumeric ISO country code. | #### Returns `Promise`<`any`\> +the result of the update operation + #### Defined in -[services/region.js:462](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L462) +[packages/medusa/src/services/region.js:462](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L462) ___ @@ -71,20 +77,25 @@ ___ ▸ **addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`any`\> +Adds a fulfillment provider that is available in the region. Fails if the +provider doesn't exist. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | -| `providerId` | `string` | | +| `regionId` | `string` | the region to add the provider to | +| `providerId` | `string` | the provider to add to the region | #### Returns `Promise`<`any`\> +the result of the update operation + #### Defined in -[services/region.js:582](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L582) +[packages/medusa/src/services/region.js:582](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L582) ___ @@ -92,20 +103,25 @@ ___ ▸ **addPaymentProvider**(`regionId`, `providerId`): `Promise`<`any`\> +Adds a payment provider that is available in the region. Fails if the +provider doesn't exist. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | -| `providerId` | `string` | | +| `regionId` | `string` | the region to add the provider to | +| `providerId` | `string` | the provider to add to the region | #### Returns `Promise`<`any`\> +the result of the update operation + #### Defined in -[services/region.js:535](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L535) +[packages/medusa/src/services/region.js:535](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L535) ___ @@ -113,19 +129,23 @@ ___ ▸ **create**(`regionObject`): `Region` +Creates a region. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionObject` | `Region` | | +| `regionObject` | `Region` | the unvalidated region | #### Returns `Region` +the newly created region + #### Defined in -[services/region.js:95](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L95) +[packages/medusa/src/services/region.js:95](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L95) ___ @@ -133,19 +153,23 @@ ___ ▸ **delete**(`regionId`): `Promise`<`any`\> +Deletes a region. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | +| `regionId` | `string` | the region to delete | #### Returns `Promise`<`any`\> +the result of the delete operation + #### Defined in -[services/region.js:432](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L432) +[packages/medusa/src/services/region.js:432](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L432) ___ @@ -153,20 +177,24 @@ ___ ▸ **list**(`selector?`, `config?`): `Promise`<`any`\> +Lists all regions based on a query + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `selector` | `any` | query object for find | +| `config` | `any` | configuration settings | #### Returns `Promise`<`any`\> +result of the find operation + #### Defined in -[services/region.js:420](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L420) +[packages/medusa/src/services/region.js:420](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L420) ___ @@ -174,20 +202,24 @@ ___ ▸ **removeCountry**(`regionId`, `code`): `Promise`<`any`\> +Removes a country from a Region + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | -| `code` | `string` | | +| `regionId` | `string` | the region to remove from | +| `code` | `string` | a 2 digit alphanumeric ISO country code to remove | #### Returns `Promise`<`any`\> +the result of the update operation + #### Defined in -[services/region.js:499](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L499) +[packages/medusa/src/services/region.js:499](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L499) ___ @@ -195,20 +227,24 @@ ___ ▸ **removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`any`\> +Removes a fulfillment provider from a region. Is idempotent. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | -| `providerId` | `string` | | +| `regionId` | `string` | the region to remove the provider from | +| `providerId` | `string` | the provider to remove from the region | #### Returns `Promise`<`any`\> +the result of the update operation + #### Defined in -[services/region.js:660](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L660) +[packages/medusa/src/services/region.js:660](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L660) ___ @@ -216,20 +252,24 @@ ___ ▸ **removePaymentProvider**(`regionId`, `providerId`): `Promise`<`any`\> +Removes a payment provider from a region. Is idempotent. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | -| `providerId` | `string` | | +| `regionId` | `string` | the region to remove the provider from | +| `providerId` | `string` | the provider to remove from the region | #### Returns `Promise`<`any`\> +the result of the update operation + #### Defined in -[services/region.js:626](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L626) +[packages/medusa/src/services/region.js:626](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L626) ___ @@ -237,20 +277,24 @@ ___ ▸ **retrieve**(`regionId`, `config?`): `Region` +Retrieves a region by its id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | -| `config` | `any` | | +| `regionId` | `string` | the id of the region to retrieve | +| `config` | `any` | configuration settings | #### Returns `Region` +the region + #### Defined in -[services/region.js:396](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L396) +[packages/medusa/src/services/region.js:396](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L396) ___ @@ -271,7 +315,7 @@ ___ #### Defined in -[services/region.js:362](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L362) +[packages/medusa/src/services/region.js:362](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L362) ___ @@ -279,20 +323,24 @@ ___ ▸ **update**(`regionId`, `update`): `Promise`<`any`\> +Updates a region + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `regionId` | `string` | | -| `update` | `any` | | +| `regionId` | `string` | the region to update | +| `update` | `any` | the data to update the region with | #### Returns `Promise`<`any`\> +the result of the update operation + #### Defined in -[services/region.js:153](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L153) +[packages/medusa/src/services/region.js:153](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L153) ___ @@ -300,12 +348,15 @@ ___ ▸ **validateCountry_**(`code`, `regionId`): `Promise`<`any`\> +Validates a country code. Will normalize the code before checking for +existence. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `code` | `string` | | -| `regionId` | `string` | | +| `code` | `string` | a 2 digit alphanumeric ISO country code | +| `regionId` | `string` | the id of the current region to check against | #### Returns @@ -313,7 +364,7 @@ ___ #### Defined in -[services/region.js:323](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L323) +[packages/medusa/src/services/region.js:323](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L323) ___ @@ -321,11 +372,13 @@ ___ ▸ **validateCurrency_**(`currencyCode`): `Promise`<`void`\> +Validates a currency code. Will throw if the currency code doesn't exist. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `currencyCode` | `string` | | +| `currencyCode` | `string` | an ISO currency code | #### Returns @@ -333,7 +386,7 @@ ___ #### Defined in -[services/region.js:302](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L302) +[packages/medusa/src/services/region.js:302](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L302) ___ @@ -341,20 +394,25 @@ ___ ▸ **validateFields_**(`region`, `id?`): `any` +Validates fields for creation and updates. If the region already exisits +the id can be passed to check that country updates are allowed. + #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `region` | `any` | `undefined` | | -| `id` | ``null`` \| `string` | `undefined` | | +| `region` | `any` | `undefined` | the region data to validate | +| `id` | ``null`` \| `string` | `undefined` | optional id of the region to check against | #### Returns `any` +the validated region data + #### Defined in -[services/region.js:213](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L213) +[packages/medusa/src/services/region.js:213](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L213) ___ @@ -362,11 +420,13 @@ ___ ▸ **validateTaxRate_**(`taxRate`): `void` +Validates a tax rate. Will throw if the tax rate is not between 0 and 1. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `taxRate` | `number` | | +| `taxRate` | `number` | a number representing the tax rate of the region | #### Returns @@ -374,7 +434,7 @@ ___ #### Defined in -[services/region.js:289](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L289) +[packages/medusa/src/services/region.js:289](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L289) ___ @@ -394,4 +454,4 @@ ___ #### Defined in -[services/region.js:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L65) +[packages/medusa/src/services/region.js:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L65) diff --git a/docs/content/references/services/classes/ReturnReasonService.md b/docs/content/references/services/classes/ReturnReasonService.md index db653646b0..e0525a12fc 100644 --- a/docs/content/references/services/classes/ReturnReasonService.md +++ b/docs/content/references/services/classes/ReturnReasonService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService`<[`ReturnReasonService`](ReturnReasonService.md)\> ↳ **`ReturnReasonService`** @@ -16,135 +16,274 @@ | Name | Type | | :------ | :------ | -| `__namedParameters` | `Object` | +| `__namedParameters` | `InjectedDependencies` | #### Overrides -BaseService.constructor +TransactionBaseService<ReturnReasonService\>.constructor #### Defined in -[services/return-reason.js:5](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L5) +[packages/medusa/src/services/return-reason.ts:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L21) + +## Properties + +### configModule + +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.configModule + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `unknown` + +#### Inherited from + +TransactionBaseService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/return-reason.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L18) + +___ + +### retReasonRepo\_ + +• `Protected` `Readonly` **retReasonRepo\_**: typeof `ReturnReasonRepository` + +#### Defined in + +[packages/medusa/src/services/return-reason.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L16) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/return-reason.ts:19](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L19) ## Methods +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) + +___ + ### create -▸ **create**(`data`): `any` +▸ **create**(`data`): `Promise`<`ReturnReason`\> #### Parameters | Name | Type | | :------ | :------ | -| `data` | `any` | +| `data` | `CreateReturnReason` | #### Returns -`any` +`Promise`<`ReturnReason`\> #### Defined in -[services/return-reason.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L30) +[packages/medusa/src/services/return-reason.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L29) ___ ### delete -▸ **delete**(`returnReasonId`): `Promise`<`any`\> +▸ **delete**(`returnReasonId`): `Promise`<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `returnReasonId` | `any` | +| `returnReasonId` | `string` | #### Returns -`Promise`<`any`\> +`Promise`<`void`\> #### Defined in -[services/return-reason.js:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L114) +[packages/medusa/src/services/return-reason.ts:110](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L110) ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<`any`\> +▸ **list**(`selector`, `config?`): `Promise`<`ReturnReason`[]\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `selector` | `Selector`<`ReturnReason`\> | the query object for find | +| `config` | `FindConfig`<`ReturnReason`\> | config object | #### Returns -`Promise`<`any`\> +`Promise`<`ReturnReason`[]\> + +the result of the find operation #### Defined in -[services/return-reason.js:82](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L82) +[packages/medusa/src/services/return-reason.ts:72](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L72) ___ ### retrieve -▸ **retrieve**(`id`, `config?`): `Promise`<`Order`\> +▸ **retrieve**(`id`, `config?`): `Promise`<`ReturnReason`\> + +Gets an order by id. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `any` | | +| `id` | `string` | id of order to retrieve | +| `config` | `FindConfig`<`ReturnReason`\> | config object | #### Returns -`Promise`<`Order`\> +`Promise`<`ReturnReason`\> + +the order document #### Defined in -[services/return-reason.js:97](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L97) +[packages/medusa/src/services/return-reason.ts:91](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L91) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ ### update -▸ **update**(`id`, `data`): `any` +▸ **update**(`id`, `data`): `Promise`<`ReturnReason`\> #### Parameters | Name | Type | | :------ | :------ | -| `id` | `any` | -| `data` | `any` | +| `id` | `string` | +| `data` | `UpdateReturnReason` | #### Returns -`any` +`Promise`<`ReturnReason`\> #### Defined in -[services/return-reason.js:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L52) +[packages/medusa/src/services/return-reason.ts:50](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return-reason.ts#L50) ___ ### withTransaction -▸ **withTransaction**(`manager`): [`ReturnReasonService`](ReturnReasonService.md) +▸ **withTransaction**(`transactionManager?`): [`ReturnReasonService`](ReturnReasonService.md) #### Parameters | Name | Type | | :------ | :------ | -| `manager` | `any` | +| `transactionManager?` | `EntityManager` | #### Returns [`ReturnReasonService`](ReturnReasonService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[services/return-reason.js:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return-reason.js#L15) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/ReturnService.md b/docs/content/references/services/classes/ReturnService.md index 7f44dfc385..5fa5547c33 100644 --- a/docs/content/references/services/classes/ReturnService.md +++ b/docs/content/references/services/classes/ReturnService.md @@ -1,5 +1,7 @@ # Class: ReturnService +Handles Returns + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +26,7 @@ BaseService.constructor #### Defined in -[services/return.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L9) +[packages/medusa/src/services/return.js:9](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L9) ## Properties @@ -34,7 +36,7 @@ BaseService.constructor #### Defined in -[services/return.js:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L49) +[packages/medusa/src/services/return.js:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L49) ___ @@ -44,7 +46,7 @@ ___ #### Defined in -[services/return.js:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L47) +[packages/medusa/src/services/return.js:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L47) ___ @@ -54,7 +56,7 @@ ___ #### Defined in -[services/return.js:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L39) +[packages/medusa/src/services/return.js:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L39) ## Methods @@ -62,19 +64,23 @@ ___ ▸ **cancel**(`returnId`): `Promise`<`Return`\> +Cancels a return if possible. Returns can be canceled if it has not been received. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `returnId` | `string` | | +| `returnId` | `string` | the id of the return to cancel. | #### Returns `Promise`<`Return`\> +the updated Return + #### Defined in -[services/return.js:134](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L134) +[packages/medusa/src/services/return.js:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L134) ___ @@ -82,19 +88,25 @@ ___ ▸ **create**(`data`): `Promise`<`Return`\> +Creates a return request for an order, with given items, and a shipping +method. If no refund amount is provided the refund amount is calculated from +the return lines and the shipping cost. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `any` | | +| `data` | `any` | data to use for the return e.g. shipping_method, items or refund_amount | #### Returns `Promise`<`Return`\> +the created return + #### Defined in -[services/return.js:307](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L307) +[packages/medusa/src/services/return.js:307](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L307) ___ @@ -114,7 +126,7 @@ ___ #### Defined in -[services/return.js:450](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L450) +[packages/medusa/src/services/return.js:450](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L450) ___ @@ -122,23 +134,27 @@ ___ ▸ **getFulfillmentItems_**(`order`, `items`, `transformer`): `Promise`<`LineItem`[]\> +Retrieves the order line items, given an array of items + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | -| `items` | `Object` | | +| `order` | `Order` | the order to get line items from | +| `items` | `Object` | the items to get | | `items.item_id` | `string` | - | | `items.quantity` | `number` | - | -| `transformer` | `Function` | | +| `transformer` | `Function` | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. | #### Returns `Promise`<`LineItem`[]\> +the line items generated by the transformer. + #### Defined in -[services/return.js:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L89) +[packages/medusa/src/services/return.js:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L89) ___ @@ -150,16 +166,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `selector` | `any` | the query object for find | +| `config` | `any` | the config object for find | #### Returns `Promise`<`any`\> +the result of the find operation + #### Defined in -[services/return.js:120](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L120) +[packages/medusa/src/services/return.js:120](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L120) ___ @@ -167,22 +185,32 @@ ___ ▸ **receive**(`return_id`, `received_items`, `refund_amount`, `allow_mismatch?`): `Promise`<`any`\> +Registers a previously requested return as received. This will create a +refund to the customer. If the returned items don't match the requested +items the return status will be updated to requires_action. This behaviour +is useful in sitautions where a custom refund amount is requested, but the +retuned items are not matching the requested items. Setting the +allowMismatch argument to true, will process the return, ignoring any +mismatches. + #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `return_id` | `string` | `undefined` | | -| `received_items` | `Item`[] | `undefined` | | -| `refund_amount` | `undefined` \| `number` | `undefined` | | -| `allow_mismatch` | `bool` | `false` | | +| `return_id` | `string` | `undefined` | the orderId to return to | +| `received_items` | `Item`[] | `undefined` | the items received after return. | +| `refund_amount` | `undefined` \| `number` | `undefined` | the amount to return | +| `allow_mismatch` | `bool` | `false` | whether to ignore return/received product mismatch | #### Returns `Promise`<`any`\> +the result of the update operation + #### Defined in -[services/return.js:524](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L524) +[packages/medusa/src/services/return.js:524](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L524) ___ @@ -190,20 +218,24 @@ ___ ▸ **retrieve**(`id`, `config?`): `Return` +Retrieves a return by its id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `any` | | +| `id` | `string` | the id of the return to retrieve | +| `config` | `any` | the config object | #### Returns `Return` +the return + #### Defined in -[services/return.js:229](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L229) +[packages/medusa/src/services/return.js:229](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L229) ___ @@ -224,7 +256,7 @@ ___ #### Defined in -[services/return.js:248](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L248) +[packages/medusa/src/services/return.js:248](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L248) ___ @@ -245,7 +277,7 @@ ___ #### Defined in -[services/return.js:271](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L271) +[packages/medusa/src/services/return.js:271](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L271) ___ @@ -253,21 +285,28 @@ ___ ▸ **validateReturnLineItem_**(`item`, `quantity`, `additional`): `LineItem` +Checks that a given quantity of a line item can be returned. Fails if the +item is undefined or if the returnable quantity of the item is lower, than +the quantity that is requested to be returned. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `item` | `any` | | -| `quantity` | `number` | | -| `additional` | `any` | | +| `item` | `any` | the line item to check has sufficient returnable quantity. | +| `quantity` | `number` | the quantity that is requested to be returned. | +| `additional` | `any` | the quantity that is requested to be returned. | #### Returns `LineItem` +a line item where the quantity is set to the requested + return quantity. + #### Defined in -[services/return.js:191](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L191) +[packages/medusa/src/services/return.js:191](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L191) ___ @@ -275,11 +314,19 @@ ___ ▸ **validateReturnStatuses_**(`order`): `void` +Checks that an order has the statuses necessary to complete a return. +fulfillment_status cannot be not_fulfilled or returned. +payment_status must be captured. + +**`Throws`** + +when statuses are not sufficient for returns. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | +| `order` | `Order` | the order to check statuses on | #### Returns @@ -287,7 +334,7 @@ ___ #### Defined in -[services/return.js:161](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L161) +[packages/medusa/src/services/return.js:161](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L161) ___ @@ -307,4 +354,4 @@ ___ #### Defined in -[services/return.js:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/return.js#L55) +[packages/medusa/src/services/return.js:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/return.js#L55) diff --git a/docs/content/references/services/classes/SalesChannelService.md b/docs/content/references/services/classes/SalesChannelService.md index ebfa85cd37..87be64af92 100644 --- a/docs/content/references/services/classes/SalesChannelService.md +++ b/docs/content/references/services/classes/SalesChannelService.md @@ -24,7 +24,7 @@ TransactionBaseService<SalesChannelService\>.constructor #### Defined in -[services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L37) +[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L37) ## Properties @@ -36,6 +36,10 @@ TransactionBaseService<SalesChannelService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +50,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### eventBusService\_ @@ -54,7 +62,7 @@ ___ #### Defined in -[services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L34) +[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L34) ___ @@ -68,7 +76,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L30) +[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L30) ___ @@ -78,7 +86,7 @@ ___ #### Defined in -[services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L33) +[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L33) ___ @@ -88,7 +96,7 @@ ___ #### Defined in -[services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L35) +[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L35) ___ @@ -102,7 +110,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L31) +[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L31) ___ @@ -120,14 +128,43 @@ ___ #### Defined in -[services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L24) +[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L24) ## Methods +### addProducts + +▸ **addProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\> + +Add a batch of product to a sales channel + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | The id of the sales channel on which to add the products | +| `productIds` | `string`[] | The products ids to attach to the sales channel | + +#### Returns + +`Promise`<`SalesChannel`\> + +the sales channel on which the products have been added + +#### Defined in + +[packages/medusa/src/services/sales-channel.ts:277](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L277) + +___ + ### atomicPhase\_ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -139,21 +176,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -161,6 +200,11 @@ ___ ▸ **create**(`data`): `Promise`<`SalesChannel`\> +Creates a SalesChannel + + This feature is under development and may change in the future. +To use this feature please enable the corresponding feature flag in your medusa backend project. + #### Parameters | Name | Type | @@ -171,9 +215,11 @@ ___ `Promise`<`SalesChannel`\> +the created channel + #### Defined in -[services/sales-channel.ts:102](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L102) +[packages/medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L134) ___ @@ -181,13 +227,17 @@ ___ ▸ **createDefault**(): `Promise`<`SalesChannel`\> +Creates a default sales channel, if this does not already exist. + #### Returns `Promise`<`SalesChannel`\> +the sales channel + #### Defined in -[services/sales-channel.ts:182](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L182) +[packages/medusa/src/services/sales-channel.ts:224](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L224) ___ @@ -195,11 +245,15 @@ ___ ▸ **delete**(`salesChannelId`): `Promise`<`void`\> +Deletes a sales channel from + This feature is under development and may change in the future. +To use this feature please enable the corresponding feature flag in your medusa backend project. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `salesChannelId` | `string` | | +| `salesChannelId` | `string` | the id of the sales channel to delete | #### Returns @@ -207,28 +261,60 @@ ___ #### Defined in -[services/sales-channel.ts:154](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L154) +[packages/medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L185) ___ ### listAndCount -▸ **listAndCount**(`selector?`, `config?`): `Promise`<[`SalesChannel`[], `number`]\> +▸ **listAndCount**(`selector`, `config?`): `Promise`<[`SalesChannel`[], `number`]\> + +Lists sales channels based on the provided parameters and includes the count of +sales channels that match the query. #### Parameters | Name | Type | | :------ | :------ | -| `selector` | `QuerySelector`<`any`\> | -| `config` | `FindConfig`<`any`\> | +| `selector` | `QuerySelector`<`SalesChannel`\> | +| `config` | `FindConfig`<`SalesChannel`\> | #### Returns `Promise`<[`SalesChannel`[], `number`]\> +an array containing the sales channels as + the first element and the total count of sales channels that matches the query + as the second element. + #### Defined in -[services/sales-channel.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L88) +[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L99) + +___ + +### removeProducts + +▸ **removeProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\> + +Remove a batch of product from a sales channel + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | The id of the sales channel on which to remove the products | +| `productIds` | `string`[] | The products ids to remove from the sales channel | + +#### Returns + +`Promise`<`SalesChannel`\> + +the sales channel on which the products have been removed + +#### Defined in + +[packages/medusa/src/services/sales-channel.ts:256](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L256) ___ @@ -236,6 +322,11 @@ ___ ▸ **retrieve**(`salesChannelId`, `config?`): `Promise`<`SalesChannel`\> +Retrieve a SalesChannel by id + + This feature is under development and may change in the future. +To use this feature please enable the corresponding feature flag in your medusa backend project. + #### Parameters | Name | Type | @@ -247,9 +338,11 @@ ___ `Promise`<`SalesChannel`\> +a sales channel + #### Defined in -[services/sales-channel.ts:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L59) +[packages/medusa/src/services/sales-channel.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L64) ___ @@ -273,7 +366,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -294,7 +387,7 @@ ___ #### Defined in -[services/sales-channel.ts:119](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/sales-channel.ts#L119) +[packages/medusa/src/services/sales-channel.ts:151](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/sales-channel.ts#L151) ___ @@ -318,4 +411,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/SearchService.md b/docs/content/references/services/classes/SearchService.md index 8a91306c1f..9a088b3e9a 100644 --- a/docs/content/references/services/classes/SearchService.md +++ b/docs/content/references/services/classes/SearchService.md @@ -2,7 +2,7 @@ ## Hierarchy -- `"medusa-interfaces"` +- `AbstractSearchService`<[`SearchService`](SearchService.md)\> ↳ **`SearchService`** @@ -10,41 +10,134 @@ ### constructor -• **new SearchService**(`container`) +• **new SearchService**(`__namedParameters`, `options`) #### Parameters | Name | Type | | :------ | :------ | -| `container` | `any` | +| `__namedParameters` | `InjectedDependencies` | +| `options` | `any` | #### Overrides -SearchService.constructor +AbstractSearchService<DefaultSearchService\>.constructor #### Defined in -[services/search.js:8](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L8) +[packages/medusa/src/services/search.ts:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L18) ## Properties -### isDefault +### configModule -• **isDefault**: `boolean` +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +AbstractSearchService.configModule #### Defined in -[services/search.js:11](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L11) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `unknown` + +#### Inherited from + +AbstractSearchService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + +___ + +### isDefault + +• **isDefault**: `boolean` = `true` + +#### Overrides + +AbstractSearchService.isDefault + +#### Defined in + +[packages/medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L11) ___ ### logger\_ -• **logger\_**: `any` +• `Protected` `Readonly` **logger\_**: `Logger` #### Defined in -[services/search.js:13](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L13) +[packages/medusa/src/services/search.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L15) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +AbstractSearchService.manager\_ + +#### Defined in + +[packages/medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L13) + +___ + +### options\_ + +• `Protected` `Readonly` **options\_**: `Record`<`string`, `unknown`\> + +#### Overrides + +AbstractSearchService.options\_ + +#### Defined in + +[packages/medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L16) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +AbstractSearchService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L14) + +## Accessors + +### options + +• `get` **options**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Inherited from + +AbstractSearchService.options + +#### Defined in + +[packages/medusa/src/interfaces/search-service.ts:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/search-service.ts#L84) ## Methods @@ -56,17 +149,60 @@ ___ | Name | Type | | :------ | :------ | -| `indexName` | `any` | -| `documents` | `any` | -| `type` | `any` | +| `indexName` | `string` | +| `documents` | `unknown` | +| `type` | `string` | #### Returns `void` +#### Overrides + +AbstractSearchService.addDocuments + #### Defined in -[services/search.js:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L28) +[packages/medusa/src/services/search.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L43) + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +AbstractSearchService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -78,16 +214,20 @@ ___ | Name | Type | | :------ | :------ | -| `indexName` | `any` | -| `options` | `any` | +| `indexName` | `string` | +| `options` | `unknown` | #### Returns `void` +#### Overrides + +AbstractSearchService.createIndex + #### Defined in -[services/search.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L16) +[packages/medusa/src/services/search.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L31) ___ @@ -99,15 +239,19 @@ ___ | Name | Type | | :------ | :------ | -| `indexName` | `any` | +| `indexName` | `string` | #### Returns `void` +#### Overrides + +AbstractSearchService.deleteAllDocuments + #### Defined in -[services/search.js:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L46) +[packages/medusa/src/services/search.ts:61](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L61) ___ @@ -119,16 +263,20 @@ ___ | Name | Type | | :------ | :------ | -| `indexName` | `any` | -| `document_id` | `any` | +| `indexName` | `string` | +| `document_id` | `string` \| `number` | #### Returns `void` +#### Overrides + +AbstractSearchService.deleteDocument + #### Defined in -[services/search.js:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L40) +[packages/medusa/src/services/search.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L55) ___ @@ -140,15 +288,19 @@ ___ | Name | Type | | :------ | :------ | -| `indexName` | `any` | +| `indexName` | `string` | #### Returns `void` +#### Overrides + +AbstractSearchService.getIndex + #### Defined in -[services/search.js:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L22) +[packages/medusa/src/services/search.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L37) ___ @@ -160,17 +312,21 @@ ___ | Name | Type | | :------ | :------ | -| `indexName` | `any` | -| `documents` | `any` | -| `type` | `any` | +| `indexName` | `string` | +| `documents` | `unknown` | +| `type` | `string` | #### Returns `void` +#### Overrides + +AbstractSearchService.replaceDocuments + #### Defined in -[services/search.js:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L34) +[packages/medusa/src/services/search.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L49) ___ @@ -182,9 +338,9 @@ ___ | Name | Type | | :------ | :------ | -| `indexName` | `any` | -| `query` | `any` | -| `options` | `any` | +| `indexName` | `string` | +| `query` | `unknown` | +| `options` | `unknown` | #### Returns @@ -192,11 +348,39 @@ ___ | Name | Type | | :------ | :------ | -| `hits` | `never`[] | +| `hits` | `unknown`[] | + +#### Overrides + +AbstractSearchService.search #### Defined in -[services/search.js:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L52) +[packages/medusa/src/services/search.ts:67](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L67) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +AbstractSearchService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -208,13 +392,41 @@ ___ | Name | Type | | :------ | :------ | -| `indexName` | `any` | -| `settings` | `any` | +| `indexName` | `string` | +| `settings` | `unknown` | #### Returns `void` +#### Overrides + +AbstractSearchService.updateSettings + #### Defined in -[services/search.js:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/search.js#L59) +[packages/medusa/src/services/search.ts:78](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/search.ts#L78) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SearchService`](SearchService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`SearchService`](SearchService.md) + +#### Inherited from + +AbstractSearchService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/ShippingOptionService.md b/docs/content/references/services/classes/ShippingOptionService.md index 3ba6707d4c..cda9917cf0 100644 --- a/docs/content/references/services/classes/ShippingOptionService.md +++ b/docs/content/references/services/classes/ShippingOptionService.md @@ -1,5 +1,7 @@ # Class: ShippingOptionService +Provides layer to manipulate profiles. + ## Hierarchy - `TransactionBaseService`<[`ShippingOptionService`](ShippingOptionService.md)\> @@ -24,7 +26,7 @@ TransactionBaseService<ShippingOptionService\>.constructor #### Defined in -[services/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L39) +[packages/medusa/src/services/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L39) ## Properties @@ -36,6 +38,10 @@ TransactionBaseService<ShippingOptionService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +52,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### manager\_ @@ -58,7 +68,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/shipping-option.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L36) +[packages/medusa/src/services/shipping-option.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L36) ___ @@ -68,7 +78,7 @@ ___ #### Defined in -[services/shipping-option.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L34) +[packages/medusa/src/services/shipping-option.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L34) ___ @@ -78,7 +88,7 @@ ___ #### Defined in -[services/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L33) +[packages/medusa/src/services/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L33) ___ @@ -88,7 +98,7 @@ ___ #### Defined in -[services/shipping-option.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L30) +[packages/medusa/src/services/shipping-option.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L30) ___ @@ -98,7 +108,7 @@ ___ #### Defined in -[services/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L31) +[packages/medusa/src/services/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L31) ___ @@ -108,7 +118,7 @@ ___ #### Defined in -[services/shipping-option.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L32) +[packages/medusa/src/services/shipping-option.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L32) ___ @@ -122,7 +132,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L37) +[packages/medusa/src/services/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L37) ## Methods @@ -130,20 +140,25 @@ TransactionBaseService.transactionManager\_ ▸ **addRequirement**(`optionId`, `requirement`): `Promise`<`ShippingOption`\> +Adds a requirement to a shipping option. Only 1 requirement of each type +is allowed. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `optionId` | `string` | | -| `requirement` | `ShippingOptionRequirement` | | +| `optionId` | `string` | the option to add the requirement to. | +| `requirement` | `ShippingOptionRequirement` | the requirement for the option. | #### Returns `Promise`<`ShippingOption`\> +the result of update + #### Defined in -[services/shipping-option.ts:627](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L627) +[packages/medusa/src/services/shipping-option.ts:623](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L623) ___ @@ -151,6 +166,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -162,21 +181,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -184,19 +205,25 @@ ___ ▸ **create**(`data`): `Promise`<`ShippingOption`\> +Creates a new shipping option. Used both for outbound and inbound shipping +options. The difference is registered by the `is_return` field which +defaults to false. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `CreateShippingOptionInput` | | +| `data` | `CreateShippingOptionInput` | the data to create shipping options | #### Returns `Promise`<`ShippingOption`\> +the result of the create operation + #### Defined in -[services/shipping-option.ts:384](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L384) +[packages/medusa/src/services/shipping-option.ts:380](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L380) ___ @@ -204,21 +231,25 @@ ___ ▸ **createShippingMethod**(`optionId`, `data`, `config`): `Promise`<`ShippingMethod`\> +Creates a shipping method for a given cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `optionId` | `string` | | -| `data` | `object` | | -| `config` | `CreateShippingMethodDto` | | +| `optionId` | `string` | the id of the option to use for the method. | +| `data` | `object` | the optional provider data to use. | +| `config` | `CreateShippingMethodDto` | the cart to create the shipping method for. | #### Returns `Promise`<`ShippingMethod`\> +the resulting shipping method. + #### Defined in -[services/shipping-option.ts:259](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L259) +[packages/medusa/src/services/shipping-option.ts:253](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L253) ___ @@ -226,19 +257,23 @@ ___ ▸ **delete**(`optionId`): `Promise`<`void` \| `ShippingOption`\> +Deletes a profile with a given profile id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `optionId` | `string` | | +| `optionId` | `string` | the id of the profile to delete. Must be castable as an ObjectId | #### Returns `Promise`<`void` \| `ShippingOption`\> +the result of the delete operation. + #### Defined in -[services/shipping-option.ts:605](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L605) +[packages/medusa/src/services/shipping-option.ts:601](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L601) ___ @@ -246,19 +281,23 @@ ___ ▸ **deleteShippingMethods**(`shippingMethods`): `Promise`<`ShippingMethod`[]\> +Removes a given shipping method + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `shippingMethods` | `ShippingMethod` \| `ShippingMethod`[] | | +| `shippingMethods` | `ShippingMethod` \| `ShippingMethod`[] | the shipping method to remove | #### Returns `Promise`<`ShippingMethod`[]\> +removed shipping methods + #### Defined in -[services/shipping-option.ts:239](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L239) +[packages/medusa/src/services/shipping-option.ts:233](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L233) ___ @@ -266,21 +305,27 @@ ___ ▸ **getPrice_**(`option`, `data`, `cart`): `Promise`<`number`\> +Returns the amount to be paid for a shipping method. Will ask the +fulfillment provider to calculate the price if the shipping option has the +price type "calculated". + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `option` | `ShippingOption` | | -| `data` | `object` | | -| `cart` | `undefined` \| `Order` \| `Cart` | | +| `option` | `ShippingOption` | the shipping option to retrieve the price for. | +| `data` | `object` | the shipping data to retrieve the price. | +| `cart` | `undefined` \| `Order` \| `Cart` | the context in which the price should be retrieved. | #### Returns `Promise`<`number`\> +the price of the shipping option. + #### Defined in -[services/shipping-option.ts:686](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L686) +[packages/medusa/src/services/shipping-option.ts:682](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L682) ___ @@ -292,16 +337,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`ShippingMethod`\> | | -| `config` | `FindConfig`<`ShippingOption`\> | | +| `selector` | `Selector`<`ShippingMethod`\> | the query object for find | +| `config` | `FindConfig`<`ShippingOption`\> | config object | #### Returns `Promise`<`ShippingOption`[]\> +the result of the find operation + #### Defined in -[services/shipping-option.ts:130](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L130) +[packages/medusa/src/services/shipping-option.ts:130](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L130) ___ @@ -313,16 +360,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `Selector`<`ShippingMethod`\> | | -| `config` | `FindConfig`<`ShippingOption`\> | | +| `selector` | `Selector`<`ShippingMethod`\> | the query object for find | +| `config` | `FindConfig`<`ShippingOption`\> | config object | #### Returns `Promise`<[`ShippingOption`[], `number`]\> +the result of the find operation + #### Defined in -[services/shipping-option.ts:149](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L149) +[packages/medusa/src/services/shipping-option.ts:146](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L146) ___ @@ -330,19 +379,23 @@ ___ ▸ **removeRequirement**(`requirementId`): `Promise`<`void` \| `ShippingOptionRequirement`\> +Removes a requirement from a shipping option + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `requirementId` | `any` | | +| `requirementId` | `any` | the id of the requirement to remove | #### Returns `Promise`<`void` \| `ShippingOptionRequirement`\> +the result of update + #### Defined in -[services/shipping-option.ts:656](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L656) +[packages/medusa/src/services/shipping-option.ts:652](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L652) ___ @@ -350,12 +403,15 @@ ___ ▸ **retrieve**(`optionId`, `options?`): `Promise`<`ShippingOption`\> +Gets a profile by id. +Throws in case of DB Error and if profile was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `optionId` | `any` | | -| `options` | `Object` | | +| `optionId` | `any` | the id of the profile to get. | +| `options` | `Object` | the options to get a profile | | `options.relations?` | `string`[] | - | | `options.select?` | keyof `ShippingOption`[] | - | @@ -363,9 +419,11 @@ ___ `Promise`<`ShippingOption`\> +the profile document. + #### Defined in -[services/shipping-option.ts:170](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L170) +[packages/medusa/src/services/shipping-option.ts:164](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L164) ___ @@ -389,7 +447,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -397,20 +455,26 @@ ___ ▸ **update**(`optionId`, `update`): `Promise`<`ShippingOption`\> +Updates a profile. Metadata updates and product updates should use +dedicated methods, e.g. `setMetadata`, etc. The function +will throw errors if metadata or product updates are attempted. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `optionId` | `string` | | -| `update` | `UpdateShippingOptionInput` | | +| `optionId` | `string` | the id of the option. Must be a string that can be casted to an ObjectId | +| `update` | `UpdateShippingOptionInput` | an object with the update values. | #### Returns `Promise`<`ShippingOption`\> +resolves to the update result. + #### Defined in -[services/shipping-option.ts:498](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L498) +[packages/medusa/src/services/shipping-option.ts:494](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L494) ___ @@ -418,41 +482,52 @@ ___ ▸ **updateShippingMethod**(`id`, `update`): `Promise`<`undefined` \| `ShippingMethod`\> +Updates a shipping method's associations. Useful when a cart is completed +and its methods should be copied to an order/swap entity. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `update` | `ShippingMethodUpdate` | | +| `id` | `string` | the id of the shipping method to update | +| `update` | `ShippingMethodUpdate` | the values to update the method with | #### Returns `Promise`<`undefined` \| `ShippingMethod`\> +the resulting shipping method + #### Defined in -[services/shipping-option.ts:210](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L210) +[packages/medusa/src/services/shipping-option.ts:204](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L204) ___ ### validateCartOption -▸ **validateCartOption**(`option`, `cart`): ``null`` \| `ShippingOption` +▸ **validateCartOption**(`option`, `cart`): `Promise`<``null`` \| `ShippingOption`\> + +Checks if a given option id is a valid option for a cart. If it is the +option is returned with the correct price. Throws when region_ids do not +match, or when the shipping option requirements are not satisfied. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `option` | `ShippingOption` | | -| `cart` | `Cart` | | +| `option` | `ShippingOption` | the option object to check | +| `cart` | `Cart` | the cart object to check against | #### Returns -``null`` \| `ShippingOption` +`Promise`<``null`` \| `ShippingOption`\> + +the validated shipping option #### Defined in -[services/shipping-option.ts:337](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L337) +[packages/medusa/src/services/shipping-option.ts:331](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L331) ___ @@ -460,20 +535,24 @@ ___ ▸ **validatePriceType_**(`priceType`, `option`): `Promise`<`ShippingOptionPriceType`\> +Validates a shipping option price + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `priceType` | `ShippingOptionPriceType` | | -| `option` | `ShippingOption` | | +| `priceType` | `ShippingOptionPriceType` | the price to validate | +| `option` | `ShippingOption` | the option to validate against | #### Returns `Promise`<`ShippingOptionPriceType`\> +the validated price + #### Defined in -[services/shipping-option.ts:462](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L462) +[packages/medusa/src/services/shipping-option.ts:458](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L458) ___ @@ -481,20 +560,24 @@ ___ ▸ **validateRequirement_**(`requirement`, `optionId?`): `Promise`<`ShippingOptionRequirement`\> +Validates a requirement + #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `requirement` | `ShippingOptionRequirement` | `undefined` | | -| `optionId` | `undefined` \| `string` | `undefined` | | +| `requirement` | `ShippingOptionRequirement` | `undefined` | the requirement to validate | +| `optionId` | `undefined` \| `string` | `undefined` | the id to validate the requirement | #### Returns `Promise`<`ShippingOptionRequirement`\> +a validated shipping requirement + #### Defined in -[services/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-option.ts#L64) +[packages/medusa/src/services/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-option.ts#L64) ___ @@ -518,4 +601,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/ShippingProfileService.md b/docs/content/references/services/classes/ShippingProfileService.md index 923587772d..8b19d8adc1 100644 --- a/docs/content/references/services/classes/ShippingProfileService.md +++ b/docs/content/references/services/classes/ShippingProfileService.md @@ -1,5 +1,9 @@ # Class: ShippingProfileService +Provides layer to manipulate profiles. + +**`Implements`** + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +28,7 @@ BaseService.constructor #### Defined in -[services/shipping-profile.js:12](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L12) +[packages/medusa/src/services/shipping-profile.js:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L12) ## Methods @@ -32,20 +36,25 @@ BaseService.constructor ▸ **addProduct**(`profileId`, `productId`): `Promise`<`any`\> +Adds a product to a profile. The method is idempotent, so multiple calls +with the same product variant will have the same result. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `profileId` | `string` | | -| `productId` | `string` | | +| `profileId` | `string` | the profile to add the product to. | +| `productId` | `string` | the product to add. | #### Returns `Promise`<`any`\> +the result of update + #### Defined in -[services/shipping-profile.js:343](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L343) +[packages/medusa/src/services/shipping-profile.js:343](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L343) ___ @@ -53,20 +62,25 @@ ___ ▸ **addShippingOption**(`profileId`, `optionId`): `Promise`<`any`\> +Adds a shipping option to the profile. The shipping option can be used to +fulfill the products in the products field. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `profileId` | `string` | | -| `optionId` | `string` | | +| `profileId` | `string` | the profile to apply the shipping option to | +| `optionId` | `string` | the option to add to the profile | #### Returns `Promise`<`any`\> +the result of the model update operation + #### Defined in -[services/shipping-profile.js:361](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L361) +[packages/medusa/src/services/shipping-profile.js:361](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L361) ___ @@ -74,19 +88,23 @@ ___ ▸ **create**(`profile`): `Promise`<`any`\> +Creates a new shipping profile. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `profile` | `ShippingProfile` | | +| `profile` | `ShippingProfile` | the shipping profile to create from | #### Returns `Promise`<`any`\> +the result of the create operation + #### Defined in -[services/shipping-profile.js:235](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L235) +[packages/medusa/src/services/shipping-profile.js:235](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L235) ___ @@ -94,13 +112,17 @@ ___ ▸ **createDefault**(): `Promise`<`ShippingProfile`\> +Creates a default shipping profile, if this does not already exist. + #### Returns `Promise`<`ShippingProfile`\> +the shipping profile + #### Defined in -[services/shipping-profile.js:167](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L167) +[packages/medusa/src/services/shipping-profile.js:167](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L167) ___ @@ -108,13 +130,18 @@ ___ ▸ **createGiftCardDefault**(): `Promise`<`ShippingProfile`\> +Creates a default shipping profile, for gift cards if unless it already +exists. + #### Returns `Promise`<`ShippingProfile`\> +the shipping profile + #### Defined in -[services/shipping-profile.js:209](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L209) +[packages/medusa/src/services/shipping-profile.js:209](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L209) ___ @@ -122,21 +149,25 @@ ___ ▸ **decorate**(`profile`, `fields`, `expandFields?`): `Profile` +Decorates a profile. + #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `profile` | `Profile` | `undefined` | | -| `fields` | `string`[] | `undefined` | | -| `expandFields` | `string`[] | `[]` | | +| `profile` | `Profile` | `undefined` | the profile to decorate. | +| `fields` | `string`[] | `undefined` | the fields to include. | +| `expandFields` | `string`[] | `[]` | fields to expand. | #### Returns `Profile` +return the decorated profile. + #### Defined in -[services/shipping-profile.js:379](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L379) +[packages/medusa/src/services/shipping-profile.js:379](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L379) ___ @@ -144,19 +175,23 @@ ___ ▸ **delete**(`profileId`): `Promise`<`any`\> +Deletes a profile with a given profile id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `profileId` | `string` | | +| `profileId` | `string` | the id of the profile to delete. Must be castable as an ObjectId | #### Returns `Promise`<`any`\> +the result of the delete operation. + #### Defined in -[services/shipping-profile.js:317](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L317) +[packages/medusa/src/services/shipping-profile.js:317](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L317) ___ @@ -164,19 +199,24 @@ ___ ▸ **fetchCartOptions**(`cart`): `Promise`<[`ShippingOption`]\> +Finds all the shipping profiles that cover the products in a cart, and +validates all options that are available for the cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cart` | `Cart` | | +| `cart` | `Cart` | the cart object to find shipping options for | #### Returns `Promise`<[`ShippingOption`]\> +a list of the available shipping options + #### Defined in -[services/shipping-profile.js:425](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L425) +[packages/medusa/src/services/shipping-profile.js:425](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L425) ___ @@ -197,7 +237,7 @@ ___ #### Defined in -[services/shipping-profile.js:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L73) +[packages/medusa/src/services/shipping-profile.js:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L73) ___ @@ -205,19 +245,23 @@ ___ ▸ **getProfilesInCart_**(`cart`): [`string`] +Returns a list of all the productIds in the cart. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cart` | `Cart` | | +| `cart` | `Cart` | the cart to extract products from | #### Returns [`string`] +a list of product ids + #### Defined in -[services/shipping-profile.js:406](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L406) +[packages/medusa/src/services/shipping-profile.js:406](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L406) ___ @@ -229,16 +273,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `selector` | `any` | the query object for find | +| `config` | `any` | the config object for find | #### Returns `Promise`<`any`\> +the result of the find operation + #### Defined in -[services/shipping-profile.js:64](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L64) +[packages/medusa/src/services/shipping-profile.js:64](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L64) ___ @@ -246,20 +292,25 @@ ___ ▸ **retrieve**(`profileId`, `options?`): `Promise`<`Product`\> +Gets a profile by id. +Throws in case of DB Error and if profile was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `profileId` | `string` | | -| `options` | `any` | | +| `profileId` | `string` | the id of the profile to get. | +| `options` | `any` | options opf the query. | #### Returns `Promise`<`Product`\> +the profile document. + #### Defined in -[services/shipping-profile.js:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L121) +[packages/medusa/src/services/shipping-profile.js:121](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L121) ___ @@ -273,7 +324,7 @@ ___ #### Defined in -[services/shipping-profile.js:151](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L151) +[packages/medusa/src/services/shipping-profile.js:151](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L151) ___ @@ -281,13 +332,17 @@ ___ ▸ **retrieveGiftCardDefault**(): `any` +Retrieves the default gift card profile + #### Returns `any` +the shipping profile for gift cards + #### Defined in -[services/shipping-profile.js:192](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L192) +[packages/medusa/src/services/shipping-profile.js:192](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L192) ___ @@ -295,20 +350,26 @@ ___ ▸ **update**(`profileId`, `update`): `Promise`<`any`\> +Updates a profile. Metadata updates and product updates should use +dedicated methods, e.g. `setMetadata`, `addProduct`, etc. The function +will throw errors if metadata or product updates are attempted. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `profileId` | `string` | | -| `update` | `any` | | +| `profileId` | `string` | the id of the profile. Must be a string that can be casted to an ObjectId | +| `update` | `any` | an object with the update values. | #### Returns `Promise`<`any`\> +resolves to the update result. + #### Defined in -[services/shipping-profile.js:263](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L263) +[packages/medusa/src/services/shipping-profile.js:263](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L263) ___ @@ -328,4 +389,4 @@ ___ #### Defined in -[services/shipping-profile.js:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/shipping-profile.js#L41) +[packages/medusa/src/services/shipping-profile.js:41](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/shipping-profile.js#L41) diff --git a/docs/content/references/services/classes/StoreService.md b/docs/content/references/services/classes/StoreService.md index e75d88b64d..77b777aed2 100644 --- a/docs/content/references/services/classes/StoreService.md +++ b/docs/content/references/services/classes/StoreService.md @@ -1,5 +1,7 @@ # Class: StoreService +Provides layer to manipulate store settings. + ## Hierarchy - `TransactionBaseService`<[`StoreService`](StoreService.md)\> @@ -24,7 +26,7 @@ TransactionBaseService<StoreService\>.constructor #### Defined in -[services/store.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L33) +[packages/medusa/src/services/store.ts:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L32) ## Properties @@ -36,6 +38,10 @@ TransactionBaseService<StoreService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +52,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### currencyRepository\_ @@ -54,7 +64,7 @@ ___ #### Defined in -[services/store.ts:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L30) +[packages/medusa/src/services/store.ts:29](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L29) ___ @@ -64,7 +74,7 @@ ___ #### Defined in -[services/store.ts:31](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L31) +[packages/medusa/src/services/store.ts:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L30) ___ @@ -78,7 +88,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/store.ts:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L26) +[packages/medusa/src/services/store.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L25) ___ @@ -88,7 +98,7 @@ ___ #### Defined in -[services/store.ts:29](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L29) +[packages/medusa/src/services/store.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L28) ___ @@ -102,7 +112,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/store.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L27) +[packages/medusa/src/services/store.ts:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L26) ## Methods @@ -110,19 +120,23 @@ TransactionBaseService.transactionManager\_ ▸ **addCurrency**(`code`): `Promise`<`Store`\> +Add a currency to the store + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `code` | `string` | | +| `code` | `string` | 3 character ISO currency code | #### Returns `Promise`<`Store`\> +result after update + #### Defined in -[services/store.ts:219](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L219) +[packages/medusa/src/services/store.ts:210](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L210) ___ @@ -130,6 +144,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -141,21 +159,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -163,13 +183,17 @@ ___ ▸ **create**(): `Promise`<`Store`\> +Creates a store if it doesn't already exist. + #### Returns `Promise`<`Store`\> +The store. + #### Defined in -[services/store.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L56) +[packages/medusa/src/services/store.ts:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L55) ___ @@ -189,7 +213,7 @@ ___ #### Defined in -[services/store.ts:113](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L113) +[packages/medusa/src/services/store.ts:104](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L104) ___ @@ -197,19 +221,23 @@ ___ ▸ **removeCurrency**(`code`): `Promise`<`any`\> +Removes a currency from the store + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `code` | `string` | | +| `code` | `string` | 3 character ISO currency code | #### Returns `Promise`<`any`\> +result after update + #### Defined in -[services/store.ts:263](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L263) +[packages/medusa/src/services/store.ts:254](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L254) ___ @@ -217,19 +245,23 @@ ___ ▸ **retrieve**(`config?`): `Promise`<`Store`\> +Retrieve the store settings. There is always a maximum of one store. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `config` | `FindConfig`<`Store`\> | | +| `config` | `FindConfig`<`Store`\> | The config object from which the query will be built | #### Returns `Promise`<`Store`\> +the store + #### Defined in -[services/store.ts:92](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L92) +[packages/medusa/src/services/store.ts:91](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L91) ___ @@ -253,7 +285,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -261,19 +293,23 @@ ___ ▸ **update**(`data`): `Promise`<`Store`\> +Updates a store + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `data` | `UpdateStoreInput` | | +| `data` | `UpdateStoreInput` | an object with the update values. | #### Returns `Promise`<`Store`\> +resolves to the update result. + #### Defined in -[services/store.ts:129](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/store.ts#L129) +[packages/medusa/src/services/store.ts:120](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/store.ts#L120) ___ @@ -297,4 +333,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/StrategyResolverService.md b/docs/content/references/services/classes/StrategyResolverService.md index 631a243ad3..9a5393cffd 100644 --- a/docs/content/references/services/classes/StrategyResolverService.md +++ b/docs/content/references/services/classes/StrategyResolverService.md @@ -27,7 +27,7 @@ TransactionBaseService< #### Defined in -[services/strategy-resolver.ts:17](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/strategy-resolver.ts#L17) +[packages/medusa/src/services/strategy-resolver.ts:17](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/strategy-resolver.ts#L17) ## Properties @@ -39,6 +39,10 @@ TransactionBaseService< TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -49,6 +53,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### manager\_ @@ -61,7 +69,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/strategy-resolver.ts#L14) +[packages/medusa/src/services/strategy-resolver.ts:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/strategy-resolver.ts#L14) ___ @@ -75,7 +83,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/strategy-resolver.ts:15](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/strategy-resolver.ts#L15) +[packages/medusa/src/services/strategy-resolver.ts:15](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/strategy-resolver.ts#L15) ## Methods @@ -83,6 +91,10 @@ TransactionBaseService.transactionManager\_ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -94,21 +106,23 @@ TransactionBaseService.transactionManager\_ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -134,7 +148,7 @@ ___ #### Defined in -[services/strategy-resolver.ts:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/strategy-resolver.ts#L22) +[packages/medusa/src/services/strategy-resolver.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/strategy-resolver.ts#L22) ___ @@ -158,7 +172,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -182,4 +196,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/SwapService.md b/docs/content/references/services/classes/SwapService.md index 62f24a6bba..a3c3de9540 100644 --- a/docs/content/references/services/classes/SwapService.md +++ b/docs/content/references/services/classes/SwapService.md @@ -1,5 +1,7 @@ # Class: SwapService +Handles swaps + ## Hierarchy - `"medusa-interfaces"` @@ -24,7 +26,7 @@ BaseService.constructor #### Defined in -[services/swap.js:21](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L21) +[packages/medusa/src/services/swap.js:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L21) ## Properties @@ -48,7 +50,7 @@ BaseService.constructor #### Defined in -[services/swap.js:9](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L9) +[packages/medusa/src/services/swap.js:9](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L9) ## Methods @@ -56,19 +58,25 @@ BaseService.constructor ▸ **cancel**(`swapId`): `Promise`<`Swap`\> +Cancels a given swap if possible. A swap can only be canceled if all +related returns, fulfillments, and payments have been canceled. If a swap +is associated with a refund, it cannot be canceled. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `swapId` | `string` | | +| `swapId` | `string` | the id of the swap to cancel. | #### Returns `Promise`<`Swap`\> +the canceled swap. + #### Defined in -[services/swap.js:790](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L790) +[packages/medusa/src/services/swap.js:792](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L792) ___ @@ -76,19 +84,23 @@ ___ ▸ **cancelFulfillment**(`fulfillmentId`): `Swap` +Cancels a fulfillment (if related to a swap) + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `fulfillmentId` | `string` | | +| `fulfillmentId` | `string` | the ID of the fulfillment to cancel | #### Returns `Swap` +updated swap + #### Defined in -[services/swap.js:983](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L983) +[packages/medusa/src/services/swap.js:985](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L985) ___ @@ -96,23 +108,28 @@ ___ ▸ **create**(`order`, `returnItems`, `additionalItems`, `returnShipping`, `custom?`): `Promise`<`Swap`\> +Creates a swap from an order, with given return items, additional items +and an optional return shipping method. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | -| `returnItems` | `ReturnItem`[] | | -| `additionalItems` | `undefined` \| `PreliminaryLineItem`[] | | -| `returnShipping` | `any` | | -| `custom` | `any` | | +| `order` | `Order` | the order to base the swap off. | +| `returnItems` | `ReturnItem`[] | the items to return in the swap. | +| `additionalItems` | `undefined` \| `PreliminaryLineItem`[] | the items to send to the customer. | +| `returnShipping` | `any` | an optional shipping method for returning the returnItems. | +| `custom` | `any` | contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order. | #### Returns `Promise`<`Swap`\> +the newly created swap. + #### Defined in -[services/swap.js:313](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L313) +[packages/medusa/src/services/swap.js:315](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L315) ___ @@ -120,20 +137,28 @@ ___ ▸ **createCart**(`swapId`, `customShippingOptions?`): `Promise`<`Swap`\> +Creates a cart from the given swap and order. The cart can be used to pay +for differences associated with the swap. The swap represented by the +swapId must belong to the order. Fails if there is already a cart on the +swap. + #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `swapId` | `string` | `undefined` | | -| `customShippingOptions` | `any`[] | `[]` | | +| `swapId` | `string` | `undefined` | the id of the swap to create the cart from | +| `customShippingOptions` | `any`[] | `[]` | the shipping options | #### Returns `Promise`<`Swap`\> +the swap with its cart_id prop set to the id of + the new cart. + #### Defined in -[services/swap.js:544](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L544) +[packages/medusa/src/services/swap.js:546](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L546) ___ @@ -141,20 +166,25 @@ ___ ▸ **createFulfillment**(`swapId`, `config?`): `Promise`<`Swap`\> +Fulfills the addtional items associated with the swap. Will call the +fulfillment providers associated with the shipping methods. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `swapId` | `string` | | -| `config` | `any` | | +| `swapId` | `string` | the id of the swap to fulfill, | +| `config` | `any` | optional configurations, includes optional metadata to attach to the shipment, and a no_notification flag. | #### Returns `Promise`<`Swap`\> +the updated swap with new status and fulfillments. + #### Defined in -[services/swap.js:848](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L848) +[packages/medusa/src/services/swap.js:850](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L850) ___ @@ -162,22 +192,26 @@ ___ ▸ **createShipment**(`swapId`, `fulfillmentId`, `trackingLinks`, `config?`): `Promise`<`Swap`\> +Marks a fulfillment as shipped and attaches tracking numbers. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `swapId` | `string` | | -| `fulfillmentId` | `string` | | -| `trackingLinks` | `undefined` \| `TrackingLink`[] | | -| `config` | `any` | | +| `swapId` | `string` | the id of the swap that has been shipped. | +| `fulfillmentId` | `string` | the id of the specific fulfillment that has been shipped | +| `trackingLinks` | `undefined` \| `TrackingLink`[] | the tracking numbers associated with the shipment | +| `config` | `any` | optional configurations, includes optional metadata to attach to the shipment, and a noNotification flag. | #### Returns `Promise`<`Swap`\> +the updated swap with new fulfillments and status. + #### Defined in -[services/swap.js:1016](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L1016) +[packages/medusa/src/services/swap.js:1018](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L1018) ___ @@ -185,20 +219,24 @@ ___ ▸ **deleteMetadata**(`swapId`, `key`): `Promise`<`any`\> +Dedicated method to delete metadata for a swap. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `swapId` | `string` | | -| `key` | `string` | | +| `swapId` | `string` | the order to delete metadata from. | +| `key` | `string` | key for metadata field | #### Returns `Promise`<`any`\> +resolves to the updated result. + #### Defined in -[services/swap.js:1089](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L1089) +[packages/medusa/src/services/swap.js:1091](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L1091) ___ @@ -210,16 +248,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `any` | | -| `config` | `any` | | +| `selector` | `any` | the query object for find | +| `config` | `any` | the configuration used to find the objects. contains relations, skip, and take. | #### Returns `Promise`<`any`\> +the result of the find operation + #### Defined in -[services/swap.js:238](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L238) +[packages/medusa/src/services/swap.js:240](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L240) ___ @@ -239,7 +279,7 @@ ___ #### Defined in -[services/swap.js:395](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L395) +[packages/medusa/src/services/swap.js:397](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L397) ___ @@ -251,7 +291,7 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `swapId` | `string` | | +| `swapId` | `string` | The id of the swap | #### Returns @@ -259,7 +299,7 @@ ___ #### Defined in -[services/swap.js:659](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L659) +[packages/medusa/src/services/swap.js:661](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L661) ___ @@ -267,19 +307,24 @@ ___ ▸ **registerReceived**(`id`): `Promise`<`Order`\> +Registers the swap return items as received so that they cannot be used +as a part of other swaps/returns. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | +| `id` | `string` | the id of the order with the swap. | #### Returns `Promise`<`Order`\> +the resulting order + #### Defined in -[services/swap.js:1114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L1114) +[packages/medusa/src/services/swap.js:1116](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L1116) ___ @@ -287,20 +332,24 @@ ___ ▸ **retrieve**(`id`, `config?`): `Promise`<`Swap`\> +Retrieves a swap with the given id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `id` | `string` | | -| `config` | `any` | | +| `id` | `string` | the id of the swap to retrieve | +| `config` | `any` | the configuration to retrieve the swap | #### Returns `Promise`<`Swap`\> +the swap + #### Defined in -[services/swap.js:181](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L181) +[packages/medusa/src/services/swap.js:181](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L181) ___ @@ -308,20 +357,24 @@ ___ ▸ **retrieveByCartId**(`cartId`, `relations?`): `Promise`<`Swap`\> +Retrieves a swap based on its associated cart id + #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `cartId` | `string` | `undefined` | | -| `relations` | `string`[] | `[]` | | +| `cartId` | `string` | `undefined` | the cart id that the swap's cart has | +| `relations` | `string`[] | `[]` | the relations to retrieve swap | #### Returns `Promise`<`Swap`\> +the swap + #### Defined in -[services/swap.js:216](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L216) +[packages/medusa/src/services/swap.js:218](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L218) ___ @@ -341,7 +394,7 @@ ___ #### Defined in -[services/swap.js:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L114) +[packages/medusa/src/services/swap.js:114](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L114) ___ @@ -362,7 +415,7 @@ ___ #### Defined in -[services/swap.js:511](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L511) +[packages/medusa/src/services/swap.js:513](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L513) ___ @@ -370,20 +423,26 @@ ___ ▸ **validateReturnItems_**(`order`, `returnItems`): `ReturnItems`[] +Goes through a list of return items to ensure that they exist on the +original order. If the item exists it is verified that the quantity to +return is not higher than the original quantity ordered. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `OrderLike` | | -| `returnItems` | `ReturnItem`[] | | +| `order` | `OrderLike` | the order to return from | +| `returnItems` | `ReturnItem`[] | the items to return | #### Returns `ReturnItems`[] +the validated returnItems + #### Defined in -[services/swap.js:269](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L269) +[packages/medusa/src/services/swap.js:271](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L271) ___ @@ -403,4 +462,4 @@ ___ #### Defined in -[services/swap.js:86](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/swap.js#L86) +[packages/medusa/src/services/swap.js:86](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/swap.js#L86) diff --git a/docs/content/references/services/classes/SystemPaymentProviderService.md b/docs/content/references/services/classes/SystemPaymentProviderService.md index 2e447640f0..94936ebe45 100644 --- a/docs/content/references/services/classes/SystemPaymentProviderService.md +++ b/docs/content/references/services/classes/SystemPaymentProviderService.md @@ -24,7 +24,7 @@ BaseService.constructor #### Defined in -[services/system-payment-provider.js:6](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L6) +[packages/medusa/src/services/system-payment-provider.js:6](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L6) ## Properties @@ -34,7 +34,7 @@ BaseService.constructor #### Defined in -[services/system-payment-provider.js:4](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L4) +[packages/medusa/src/services/system-payment-provider.js:4](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L4) ## Methods @@ -54,7 +54,7 @@ BaseService.constructor #### Defined in -[services/system-payment-provider.js:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L22) +[packages/medusa/src/services/system-payment-provider.js:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L22) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[services/system-payment-provider.js:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L46) +[packages/medusa/src/services/system-payment-provider.js:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L46) ___ @@ -94,7 +94,7 @@ ___ #### Defined in -[services/system-payment-provider.js:38](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L38) +[packages/medusa/src/services/system-payment-provider.js:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L38) ___ @@ -114,7 +114,7 @@ ___ #### Defined in -[services/system-payment-provider.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L10) +[packages/medusa/src/services/system-payment-provider.js:10](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L10) ___ @@ -134,7 +134,7 @@ ___ #### Defined in -[services/system-payment-provider.js:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L34) +[packages/medusa/src/services/system-payment-provider.js:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L34) ___ @@ -154,7 +154,7 @@ ___ #### Defined in -[services/system-payment-provider.js:18](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L18) +[packages/medusa/src/services/system-payment-provider.js:18](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L18) ___ @@ -174,7 +174,7 @@ ___ #### Defined in -[services/system-payment-provider.js:14](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L14) +[packages/medusa/src/services/system-payment-provider.js:14](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L14) ___ @@ -194,7 +194,7 @@ ___ #### Defined in -[services/system-payment-provider.js:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L42) +[packages/medusa/src/services/system-payment-provider.js:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L42) ___ @@ -214,7 +214,7 @@ ___ #### Defined in -[services/system-payment-provider.js:30](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L30) +[packages/medusa/src/services/system-payment-provider.js:30](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L30) ___ @@ -234,4 +234,4 @@ ___ #### Defined in -[services/system-payment-provider.js:26](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/system-payment-provider.js#L26) +[packages/medusa/src/services/system-payment-provider.js:26](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/system-payment-provider.js#L26) diff --git a/docs/content/references/services/classes/TaxProviderService.md b/docs/content/references/services/classes/TaxProviderService.md index 560a06224e..1d523841bb 100644 --- a/docs/content/references/services/classes/TaxProviderService.md +++ b/docs/content/references/services/classes/TaxProviderService.md @@ -1,8 +1,10 @@ # Class: TaxProviderService +Finds tax providers and assists in tax related operations. + ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService`<[`TaxProviderService`](TaxProviderService.md)\> ↳ **`TaxProviderService`** @@ -20,94 +22,179 @@ #### Overrides -BaseService.constructor +TransactionBaseService<TaxProviderService\>.constructor #### Defined in -[services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L49) +[packages/medusa/src/services/tax-provider.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L53) ## Properties -### container\_ +### configModule -• `Private` **container\_**: `AwilixContainer`<`any`\> +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.configModule #### Defined in -[services/tax-provider.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L40) +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `unknown` + +#### Inherited from + +TransactionBaseService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + +___ + +### container\_ + +• `Protected` `Readonly` **container\_**: `AwilixContainer`<`any`\> + +#### Defined in + +[packages/medusa/src/services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L45) + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md) + +#### Defined in + +[packages/medusa/src/services/tax-provider.ts:51](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L51) ___ ### manager\_ -• `Private` **manager\_**: `EntityManager` +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ #### Defined in -[services/tax-provider.ts:41](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L41) +[packages/medusa/src/services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L42) ___ ### redis\_ -• `Private` **redis\_**: `Redis` +• `Protected` `Readonly` **redis\_**: `Redis` #### Defined in -[services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L47) +[packages/medusa/src/services/tax-provider.ts:50](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L50) ___ ### smTaxLineRepo\_ -• `Private` **smTaxLineRepo\_**: typeof `ShippingMethodTaxLineRepository` +• `Protected` `Readonly` **smTaxLineRepo\_**: typeof `ShippingMethodTaxLineRepository` #### Defined in -[services/tax-provider.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L45) +[packages/medusa/src/services/tax-provider.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L48) ___ ### taxLineRepo\_ -• `Private` **taxLineRepo\_**: typeof `LineItemTaxLineRepository` +• `Protected` `Readonly` **taxLineRepo\_**: typeof `LineItemTaxLineRepository` #### Defined in -[services/tax-provider.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L44) +[packages/medusa/src/services/tax-provider.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L47) ___ ### taxProviderRepo\_ -• `Private` **taxProviderRepo\_**: typeof `TaxProviderRepository` +• `Protected` `Readonly` **taxProviderRepo\_**: typeof `TaxProviderRepository` #### Defined in -[services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L46) +[packages/medusa/src/services/tax-provider.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L49) ___ ### taxRateService\_ -• `Private` **taxRateService\_**: [`TaxRateService`](TaxRateService.md) +• `Protected` `Readonly` **taxRateService\_**: [`TaxRateService`](TaxRateService.md) #### Defined in -[services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L43) +[packages/medusa/src/services/tax-provider.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L46) ___ ### transactionManager\_ -• `Private` **transactionManager\_**: `EntityManager` +• `Protected` **transactionManager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ #### Defined in -[services/tax-provider.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L42) +[packages/medusa/src/services/tax-provider.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L43) ## Methods +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) + +___ + ### clearTaxLines ▸ **clearTaxLines**(`cartId`): `Promise`<`void`\> @@ -124,7 +211,7 @@ ___ #### Defined in -[services/tax-provider.ts:103](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L103) +[packages/medusa/src/services/tax-provider.ts:94](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L94) ___ @@ -132,20 +219,25 @@ ___ ▸ **createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\> +Persists the tax lines relevant for a shipping method to the database. Used +for return shipping methods. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `shippingMethod` | `ShippingMethod` | | -| `calculationContext` | `TaxCalculationContext` | | +| `shippingMethod` | `ShippingMethod` | the shipping method to create tax lines for | +| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by | #### Returns `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\> +the newly created tax lines + #### Defined in -[services/tax-provider.ts:171](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L171) +[packages/medusa/src/services/tax-provider.ts:170](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L170) ___ @@ -153,20 +245,24 @@ ___ ▸ **createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\> +Persists the tax lines relevant for an order to the database. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrLineItems` | `Cart` \| `LineItem`[] | | -| `calculationContext` | `TaxCalculationContext` | | +| `cartOrLineItems` | `Cart` \| `LineItem`[] | the cart or line items to create tax lines for | +| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by | #### Returns `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\> +the newly created tax lines + #### Defined in -[services/tax-provider.ts:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L121) +[packages/medusa/src/services/tax-provider.ts:116](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L116) ___ @@ -174,20 +270,24 @@ ___ ▸ `Private` **getCacheEntry**(`productId`, `regionId`): `Promise`<``null`` \| `TaxServiceRate`[]\> +Gets the cache results for a set of ids + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `regionId` | `string` | | +| `productId` | `string` | the product id to cache | +| `regionId` | `string` | the region id to cache | #### Returns `Promise`<``null`` \| `TaxServiceRate`[]\> +the cached result or null + #### Defined in -[services/tax-provider.ts:454](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L454) +[packages/medusa/src/services/tax-provider.ts:457](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L457) ___ @@ -195,20 +295,24 @@ ___ ▸ `Private` **getCacheKey**(`productId`, `regionId`): `string` +The cache key to get cache hits by. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `regionId` | `string` | | +| `productId` | `string` | the product id to cache | +| `regionId` | `string` | the region id to cache | #### Returns `string` +the cache key to use for the id set + #### Defined in -[services/tax-provider.ts:423](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L423) +[packages/medusa/src/services/tax-provider.ts:426](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L426) ___ @@ -216,20 +320,25 @@ ___ ▸ **getRegionRatesForProduct**(`productId`, `region`): `Promise`<`TaxServiceRate`[]\> +Gets the tax rates configured for a product. The rates are cached between +calls. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `region` | `RegionDetails` | | +| `productId` | `string` | the product id to get rates for | +| `region` | `RegionDetails` | the region to get configured rates for. | #### Returns `Promise`<`TaxServiceRate`[]\> +the tax rates configured for the shipping option. + #### Defined in -[services/tax-provider.ts:378](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L378) +[packages/medusa/src/services/tax-provider.ts:379](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L379) ___ @@ -237,20 +346,25 @@ ___ ▸ **getRegionRatesForShipping**(`optionId`, `regionDetails`): `Promise`<`TaxServiceRate`[]\> +Gets the tax rates configured for a shipping option. The rates are cached +between calls. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `optionId` | `string` | | -| `regionDetails` | `RegionDetails` | | +| `optionId` | `string` | the option id of the shipping method. | +| `regionDetails` | `RegionDetails` | the region to get configured rates for. | #### Returns `Promise`<`TaxServiceRate`[]\> +the tax rates configured for the shipping option. + #### Defined in -[services/tax-provider.ts:332](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L332) +[packages/medusa/src/services/tax-provider.ts:333](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L333) ___ @@ -258,20 +372,26 @@ ___ ▸ **getShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<`ShippingMethodTaxLine`[]\> +Gets the relevant tax lines for a shipping method. Note: this method +doesn't persist the tax lines. Use createShippingTaxLines if you wish to +persist the tax lines to the DB layer. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `shippingMethod` | `ShippingMethod` | | -| `calculationContext` | `TaxCalculationContext` | | +| `shippingMethod` | `ShippingMethod` | the shipping method to get tax lines for | +| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by | #### Returns `Promise`<`ShippingMethodTaxLine`[]\> +the computed tax lines + #### Defined in -[services/tax-provider.ts:190](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L190) +[packages/medusa/src/services/tax-provider.ts:191](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L191) ___ @@ -279,20 +399,28 @@ ___ ▸ **getTaxLines**(`lineItems`, `calculationContext`): `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\> +Gets the relevant tax lines for an order or cart. If an order is provided +the order's tax lines will be returned. If a cart is provided the tax lines +will be computed from the tax rules and potentially a 3rd party tax plugin. +Note: this method doesn't persist the tax lines. Use createTaxLines if you +wish to persist the tax lines to the DB layer. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `lineItems` | `LineItem`[] | | -| `calculationContext` | `TaxCalculationContext` | | +| `lineItems` | `LineItem`[] | the cart or order to get tax lines for | +| `calculationContext` | `TaxCalculationContext` | the calculation context to get tax lines by | #### Returns `Promise`<(`LineItemTaxLine` \| `ShippingMethodTaxLine`)[]\> +the computed tax lines + #### Defined in -[services/tax-provider.ts:242](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L242) +[packages/medusa/src/services/tax-provider.ts:243](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L243) ___ @@ -306,7 +434,7 @@ ___ #### Defined in -[services/tax-provider.ts:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L75) +[packages/medusa/src/services/tax-provider.ts:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L66) ___ @@ -326,7 +454,7 @@ ___ #### Defined in -[services/tax-provider.ts:475](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L475) +[packages/medusa/src/services/tax-provider.ts:478](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L478) ___ @@ -334,19 +462,23 @@ ___ ▸ **retrieveProvider**(`region`): `ITaxService` +Retrieves the relevant tax provider for the given region. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `region` | `Region` | | +| `region` | `Region` | the region to get tax provider for. | #### Returns `ITaxService` +the region specific tax provider + #### Defined in -[services/tax-provider.ts:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L85) +[packages/medusa/src/services/tax-provider.ts:76](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L76) ___ @@ -354,38 +486,70 @@ ___ ▸ `Private` **setCache**(`productId`, `regionId`, `value`): `Promise`<`void`\> +Sets the cache results for a set of ids + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `productId` | `string` | | -| `regionId` | `string` | | -| `value` | `TaxServiceRate`[] | | +| `productId` | `string` | the product id to cache | +| `regionId` | `string` | the region id to cache | +| `value` | `TaxServiceRate`[] | tax rates to cache | #### Returns `Promise`<`void`\> +promise that resolves after the cache has been set + #### Defined in -[services/tax-provider.ts:434](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L434) +[packages/medusa/src/services/tax-provider.ts:437](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-provider.ts#L437) ___ -### withTransaction +### shouldRetryTransaction\_ -▸ **withTransaction**(`transactionManager`): [`TaxProviderService`](TaxProviderService.md) +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters | Name | Type | | :------ | :------ | -| `transactionManager` | `EntityManager` | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TaxProviderService`](TaxProviderService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | #### Returns [`TaxProviderService`](TaxProviderService.md) +#### Inherited from + +TransactionBaseService.withTransaction + #### Defined in -[services/tax-provider.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-provider.ts#L62) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/TaxRateService.md b/docs/content/references/services/classes/TaxRateService.md index 25e8997c67..60f877c540 100644 --- a/docs/content/references/services/classes/TaxRateService.md +++ b/docs/content/references/services/classes/TaxRateService.md @@ -24,7 +24,7 @@ BaseService.constructor #### Defined in -[services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L27) +[packages/medusa/src/services/tax-rate.ts:27](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L27) ## Properties @@ -34,7 +34,7 @@ BaseService.constructor #### Defined in -[services/tax-rate.ts:21](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L21) +[packages/medusa/src/services/tax-rate.ts:21](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L21) ___ @@ -44,7 +44,7 @@ ___ #### Defined in -[services/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L22) +[packages/medusa/src/services/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L22) ___ @@ -54,7 +54,7 @@ ___ #### Defined in -[services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L23) +[packages/medusa/src/services/tax-rate.ts:23](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L23) ___ @@ -64,7 +64,7 @@ ___ #### Defined in -[services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L24) +[packages/medusa/src/services/tax-rate.ts:24](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L24) ___ @@ -74,7 +74,7 @@ ___ #### Defined in -[services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L25) +[packages/medusa/src/services/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L25) ## Methods @@ -96,7 +96,7 @@ ___ #### Defined in -[services/tax-rate.ts:197](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L197) +[packages/medusa/src/services/tax-rate.ts:196](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L196) ___ @@ -118,7 +118,7 @@ ___ #### Defined in -[services/tax-rate.ts:233](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L233) +[packages/medusa/src/services/tax-rate.ts:232](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L232) ___ @@ -140,7 +140,7 @@ ___ #### Defined in -[services/tax-rate.ts:273](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L273) +[packages/medusa/src/services/tax-rate.ts:272](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L272) ___ @@ -160,7 +160,7 @@ ___ #### Defined in -[services/tax-rate.ts:104](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L104) +[packages/medusa/src/services/tax-rate.ts:103](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L103) ___ @@ -180,7 +180,7 @@ ___ #### Defined in -[services/tax-rate.ts:135](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L135) +[packages/medusa/src/services/tax-rate.ts:134](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L134) ___ @@ -201,7 +201,7 @@ ___ #### Defined in -[services/tax-rate.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L62) +[packages/medusa/src/services/tax-rate.ts:62](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L62) ___ @@ -222,7 +222,7 @@ ___ #### Defined in -[services/tax-rate.ts:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L73) +[packages/medusa/src/services/tax-rate.ts:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L73) ___ @@ -243,7 +243,7 @@ ___ #### Defined in -[services/tax-rate.ts:321](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L321) +[packages/medusa/src/services/tax-rate.ts:320](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L320) ___ @@ -263,7 +263,7 @@ ___ #### Defined in -[services/tax-rate.ts:332](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L332) +[packages/medusa/src/services/tax-rate.ts:330](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L330) ___ @@ -284,7 +284,7 @@ ___ #### Defined in -[services/tax-rate.ts:143](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L143) +[packages/medusa/src/services/tax-rate.ts:142](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L142) ___ @@ -305,7 +305,7 @@ ___ #### Defined in -[services/tax-rate.ts:161](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L161) +[packages/medusa/src/services/tax-rate.ts:160](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L160) ___ @@ -326,7 +326,7 @@ ___ #### Defined in -[services/tax-rate.ts:179](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L179) +[packages/medusa/src/services/tax-rate.ts:178](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L178) ___ @@ -347,7 +347,7 @@ ___ #### Defined in -[services/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L84) +[packages/medusa/src/services/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L84) ___ @@ -368,7 +368,7 @@ ___ #### Defined in -[services/tax-rate.ts:120](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L120) +[packages/medusa/src/services/tax-rate.ts:119](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L119) ___ @@ -388,4 +388,4 @@ ___ #### Defined in -[services/tax-rate.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/tax-rate.ts#L43) +[packages/medusa/src/services/tax-rate.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/tax-rate.ts#L43) diff --git a/docs/content/references/services/classes/TotalsService.md b/docs/content/references/services/classes/TotalsService.md index e190321a5a..68ee5966a6 100644 --- a/docs/content/references/services/classes/TotalsService.md +++ b/docs/content/references/services/classes/TotalsService.md @@ -1,8 +1,12 @@ # Class: TotalsService +A service that calculates total and subtotals for orders, carts etc.. + +**`Implements`** + ## Hierarchy -- `"medusa-interfaces"` +- `TransactionBaseService`<[`TotalsService`](TotalsService.md)\> ↳ **`TotalsService`** @@ -20,21 +24,63 @@ #### Overrides -BaseService.constructor +TransactionBaseService<TotalsService\>.constructor #### Defined in -[services/totals.ts:90](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L90) +[packages/medusa/src/services/totals.ts:99](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L99) ## Properties +### configModule + +• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\> + +#### Inherited from + +TransactionBaseService.configModule + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + +___ + +### container + +• `Protected` `Readonly` **container**: `unknown` + +#### Inherited from + +TransactionBaseService.container + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.manager\_ + +#### Defined in + +[packages/medusa/src/services/totals.ts:93](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L93) + +___ + ### taxCalculationStrategy\_ • `Private` **taxCalculationStrategy\_**: `ITaxCalculationStrategy` #### Defined in -[services/totals.ts:88](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L88) +[packages/medusa/src/services/totals.ts:97](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L97) ___ @@ -44,31 +90,88 @@ ___ #### Defined in -[services/totals.ts:87](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L87) +[packages/medusa/src/services/totals.ts:96](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L96) + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `EntityManager` + +#### Overrides + +TransactionBaseService.transactionManager\_ + +#### Defined in + +[packages/medusa/src/services/totals.ts:94](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L94) ## Methods -### calculateDiscount\_ +### atomicPhase\_ -▸ **calculateDiscount_**(`lineItem`, `variant`, `variantPrice`, `value`, `discountType`): `LineDiscount` +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `lineItem` | `LineItem` | | -| `variant` | `string` | | -| `variantPrice` | `number` | | -| `value` | `number` | | -| `discountType` | `DiscountRuleType` | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +TransactionBaseService.atomicPhase\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) + +___ + +### calculateDiscount\_ + +▸ **calculateDiscount_**(`lineItem`, `variant`, `variantPrice`, `value`, `discountType`): `LineDiscount` + +Calculates either fixed or percentage discount of a variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItem` | `LineItem` | id of line item | +| `variant` | `string` | id of variant in line item | +| `variantPrice` | `number` | price of the variant based on region | +| `value` | `number` | discount value | +| `discountType` | `DiscountRuleType` | the type of discount (fixed or percentage) | #### Returns `LineDiscount` +triples of lineitem, variant and applied discount + #### Defined in -[services/totals.ts:553](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L553) +[packages/medusa/src/services/totals.ts:567](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L567) ___ @@ -76,20 +179,28 @@ ___ ▸ **getAllocationItemDiscounts**(`discount`, `cart`): `LineDiscount`[] +If the rule of a discount has allocation="item", then we need +to calculate discount on each item in the cart. Furthermore, we need to +make sure to only apply the discount on valid variants. And finally we +return ether an array of percentages discounts or fixed discounts +alongside the variant on which the discount was applied. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `discount` | `Discount` | | -| `cart` | `Order` \| `Cart` | | +| `discount` | `Discount` | the discount to which we do the calculation | +| `cart` | `Order` \| `Cart` | the cart to calculate discounts for | #### Returns `LineDiscount`[] +array of triples of lineitem, variant and applied discount + #### Defined in -[services/totals.ts:595](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L595) +[packages/medusa/src/services/totals.ts:609](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L609) ___ @@ -97,20 +208,26 @@ ___ ▸ **getAllocationMap**(`orderOrCart`, `options?`): `LineAllocationsMap` +Gets a map of discounts and gift cards that apply to line items in an +order. The function calculates the amount of a discount or gift card that +applies to a specific line item. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `orderOrCart` | `Order` \| `Cart` | | -| `options` | `AllocationMapOptions` | | +| `orderOrCart` | `Order` \| `Cart` | the order or cart to get an allocation map for | +| `options` | `AllocationMapOptions` | controls what should be included in allocation map | #### Returns `LineAllocationsMap` +the allocation map for the line items in the cart or order. + #### Defined in -[services/totals.ts:376](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L376) +[packages/medusa/src/services/totals.ts:390](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L390) ___ @@ -118,20 +235,24 @@ ___ ▸ **getCalculationContext**(`cartOrOrder`, `options?`): `TaxCalculationContext` +Prepares the calculation context for a tax total calculation. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | | -| `options` | `CalculationContextOptions` | | +| `cartOrOrder` | `Order` \| `Cart` | the cart or order to get the calculation context for | +| `options` | `CalculationContextOptions` | options to gather context by | #### Returns `TaxCalculationContext` +the tax calculation context + #### Defined in -[services/totals.ts:959](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L959) +[packages/medusa/src/services/totals.ts:972](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L972) ___ @@ -139,19 +260,24 @@ ___ ▸ **getDiscountTotal**(`cartOrOrder`): `number` +Calculates the total discount amount for each of the different supported +discount types. If discounts aren't present or invalid returns 0. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | | +| `cartOrOrder` | `Order` \| `Cart` | the cart or order to calculate discounts for | #### Returns `number` +the total discounts amount + #### Defined in -[services/totals.ts:925](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L925) +[packages/medusa/src/services/totals.ts:938](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L938) ___ @@ -159,16 +285,20 @@ ___ ▸ **getGiftCardTotal**(`cartOrOrder`): `Object` +Gets the gift card amount on a cart or order. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | | +| `cartOrOrder` | `Order` \| `Cart` | the cart or order to get gift card amount for | #### Returns `Object` +the gift card amount applied to the cart or order + | Name | Type | | :------ | :------ | | `tax_total` | `number` | @@ -176,7 +306,7 @@ ___ #### Defined in -[services/totals.ts:853](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L853) +[packages/medusa/src/services/totals.ts:866](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L866) ___ @@ -184,19 +314,24 @@ ___ ▸ **getGiftCardableAmount**(`cartOrOrder`): `Promise`<`number`\> +Gets the amount that can be gift carded on a cart. In regions where gift +cards are taxable this amount should exclude taxes. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | | +| `cartOrOrder` | `Order` \| `Cart` | the cart or order to get gift card amount for | #### Returns `Promise`<`number`\> +the gift card amount applied to the cart or order + #### Defined in -[services/totals.ts:838](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L838) +[packages/medusa/src/services/totals.ts:851](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L851) ___ @@ -204,20 +339,25 @@ ___ ▸ **getLineDiscounts**(`cartOrOrder`, `discount`): `LineDiscountAmount`[] +Returns the discount amount allocated to the line items of an order. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | | -| `discount` | `Discount` | | +| `cartOrOrder` | `Order` \| `Cart` | the cart or order to get line discount allocations for | +| `discount` | `Discount` | the discount to use as context for the calculation | #### Returns `LineDiscountAmount`[] +the allocations that the discount has on the items in the cart or + order + #### Defined in -[services/totals.ts:646](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L646) +[packages/medusa/src/services/totals.ts:660](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L660) ___ @@ -237,7 +377,7 @@ ___ #### Defined in -[services/totals.ts:623](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L623) +[packages/medusa/src/services/totals.ts:637](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L637) ___ @@ -258,7 +398,7 @@ ___ #### Defined in -[services/totals.ts:608](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L608) +[packages/medusa/src/services/totals.ts:622](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L622) ___ @@ -266,20 +406,24 @@ ___ ▸ **getLineItemRefund**(`order`, `lineItem`): `number` +The amount that can be refunded for a given line item. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | -| `lineItem` | `LineItem` | | +| `order` | `Order` | order to use as context for the calculation | +| `lineItem` | `LineItem` | the line item to calculate the refund amount for. | #### Returns `number` +the line item refund amount. + #### Defined in -[services/totals.ts:468](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L468) +[packages/medusa/src/services/totals.ts:482](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L482) ___ @@ -287,21 +431,26 @@ ___ ▸ **getLineItemTotal**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<`number`\> +Gets a total for a line item. The total can take gift cards, discounts and +taxes into account. This can be controlled through the options. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `lineItem` | `LineItem` | | -| `cartOrOrder` | `Order` \| `Cart` | | -| `options` | `GetLineItemTotalOptions` | | +| `lineItem` | `LineItem` | the line item to calculate a total for | +| `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the calculation | +| `options` | `GetLineItemTotalOptions` | the options to use for the calculation | #### Returns `Promise`<`number`\> +the line item total + #### Defined in -[services/totals.ts:807](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L807) +[packages/medusa/src/services/totals.ts:820](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L820) ___ @@ -309,21 +458,27 @@ ___ ▸ **getLineItemTotals**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<`LineItemTotals`\> +Breaks down the totals related to a line item; these are the subtotal, the +amount of discount applied to the line item, the amount of a gift card +applied to a line item and the amount of tax applied to a line item. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `lineItem` | `LineItem` | | -| `cartOrOrder` | `Order` \| `Cart` | | -| `options` | `LineItemTotalsOptions` | | +| `lineItem` | `LineItem` | the line item to calculate totals for | +| `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the calculation | +| `options` | `LineItemTotalsOptions` | the options to evaluate the line item totals for | #### Returns `Promise`<`LineItemTotals`\> +the breakdown of the line item totals + #### Defined in -[services/totals.ts:692](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L692) +[packages/medusa/src/services/totals.ts:706](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L706) ___ @@ -331,19 +486,23 @@ ___ ▸ **getPaidTotal**(`order`): `number` +Gets the total payments made on an order + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | +| `order` | `Order` | the order to calculate paid amount for | #### Returns `number` +the total paid amount + #### Defined in -[services/totals.ts:129](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L129) +[packages/medusa/src/services/totals.ts:145](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L145) ___ @@ -351,20 +510,26 @@ ___ ▸ **getRefundTotal**(`order`, `lineItems`): `number` +Calculates refund total of line items. +If any of the items to return have been discounted, we need to +apply the discount again before refunding them. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | -| `lineItems` | `LineItem`[] | | +| `order` | `Order` | cart or order to calculate subtotal for | +| `lineItems` | `LineItem`[] | the line items to calculate refund total for | #### Returns `number` +the calculated subtotal + #### Defined in -[services/totals.ts:512](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L512) +[packages/medusa/src/services/totals.ts:526](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L526) ___ @@ -372,19 +537,23 @@ ___ ▸ **getRefundedTotal**(`order`): `number` +Gets the total refund amount for an order. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | +| `order` | `Order` | the order to get total refund amount for. | #### Returns `number` +the total refunded amount for an order. + #### Defined in -[services/totals.ts:453](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L453) +[packages/medusa/src/services/totals.ts:467](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L467) ___ @@ -392,21 +561,26 @@ ___ ▸ **getShippingMethodTotals**(`shippingMethod`, `cartOrOrder`, `opts?`): `Promise`<`ShippingMethodTotals`\> +Gets the totals breakdown for a shipping method. Fetches tax lines if not +already provided. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `shippingMethod` | `ShippingMethod` | | -| `cartOrOrder` | `Order` \| `Cart` | | -| `opts` | `GetShippingMethodTotalsOptions` | | +| `shippingMethod` | `ShippingMethod` | the shipping method to get totals breakdown for. | +| `cartOrOrder` | `Order` \| `Cart` | the cart or order to use as context for the breakdown | +| `opts` | `GetShippingMethodTotalsOptions` | options for what should be included | #### Returns `Promise`<`ShippingMethodTotals`\> +An object that breaks down the totals for the shipping method + #### Defined in -[services/totals.ts:163](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L163) +[packages/medusa/src/services/totals.ts:179](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L179) ___ @@ -414,19 +588,23 @@ ___ ▸ **getShippingTotal**(`cartOrOrder`): `number` +Calculates shipping total + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | | +| `cartOrOrder` | `Order` \| `Cart` | cart or order to calculate subtotal for | #### Returns `number` +shipping total + #### Defined in -[services/totals.ts:271](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L271) +[packages/medusa/src/services/totals.ts:286](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L286) ___ @@ -434,20 +612,24 @@ ___ ▸ **getSubtotal**(`cartOrOrder`, `opts?`): `number` +Calculates subtotal of a given cart or order. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | | -| `opts` | `SubtotalOptions` | | +| `cartOrOrder` | `Order` \| `Cart` | cart or order to calculate subtotal for | +| `opts` | `SubtotalOptions` | options | #### Returns `number` +the calculated subtotal + #### Defined in -[services/totals.ts:247](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L247) +[packages/medusa/src/services/totals.ts:262](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L262) ___ @@ -455,19 +637,24 @@ ___ ▸ **getSwapTotal**(`order`): `number` +The total paid for swaps. May be negative in case of negative swap +difference. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `order` | `Order` | | +| `order` | `Order` | the order to calculate swap total for | #### Returns `number` +the swap total + #### Defined in -[services/totals.ts:144](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L144) +[packages/medusa/src/services/totals.ts:160](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L160) ___ @@ -475,20 +662,25 @@ ___ ▸ **getTaxTotal**(`cartOrOrder`, `forceTaxes?`): `Promise`<``null`` \| `number`\> +Calculates tax total +Currently based on the Danish tax system + #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | `undefined` | | -| `forceTaxes` | `boolean` | `false` | | +| `cartOrOrder` | `Order` \| `Cart` | `undefined` | cart or order to calculate tax total for | +| `forceTaxes` | `boolean` | `false` | whether taxes should be calculated regardless of region settings | #### Returns `Promise`<``null`` \| `number`\> +tax total + #### Defined in -[services/totals.ts:286](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L286) +[packages/medusa/src/services/totals.ts:301](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L301) ___ @@ -496,20 +688,24 @@ ___ ▸ **getTotal**(`cartOrOrder`, `options?`): `Promise`<`number`\> +Calculates subtotal of a given cart or order. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `cartOrOrder` | `Order` \| `Cart` | | -| `options` | `GetTotalsOptions` | | +| `cartOrOrder` | `Order` \| `Cart` | object to calculate total for | +| `options` | `GetTotalsOptions` | options to calculate by | #### Returns `Promise`<`number`\> +the calculated subtotal + #### Defined in -[services/totals.ts:106](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L106) +[packages/medusa/src/services/totals.ts:122](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L122) ___ @@ -517,16 +713,68 @@ ___ ▸ **rounded**(`value`): `number` +Rounds a number using Math.round. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `value` | `number` | | +| `value` | `number` | the value to round | #### Returns `number` +the rounded value + #### Defined in -[services/totals.ts:989](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/totals.ts#L989) +[packages/medusa/src/services/totals.ts:1002](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/totals.ts#L1002) + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +TransactionBaseService.shouldRetryTransaction\_ + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TotalsService`](TotalsService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`TotalsService`](TotalsService.md) + +#### Inherited from + +TransactionBaseService.withTransaction + +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/docs/content/references/services/classes/UserService.md b/docs/content/references/services/classes/UserService.md index 87cd7f49d5..1ebe892a38 100644 --- a/docs/content/references/services/classes/UserService.md +++ b/docs/content/references/services/classes/UserService.md @@ -1,5 +1,7 @@ # Class: UserService +Provides layer to manipulate users. + ## Hierarchy - `TransactionBaseService`<[`UserService`](UserService.md)\> @@ -24,7 +26,7 @@ TransactionBaseService<UserService\>.constructor #### Defined in -[services/user.ts:37](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L37) +[packages/medusa/src/services/user.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L40) ## Properties @@ -36,6 +38,10 @@ TransactionBaseService<UserService\>.constructor TransactionBaseService.configModule +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13) + ___ ### container @@ -46,6 +52,10 @@ ___ TransactionBaseService.container +#### Defined in + +[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12) + ___ ### eventBus\_ @@ -54,7 +64,7 @@ ___ #### Defined in -[services/user.ts:35](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L35) +[packages/medusa/src/services/user.ts:38](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L38) ___ @@ -68,7 +78,7 @@ TransactionBaseService.manager\_ #### Defined in -[services/user.ts:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L32) +[packages/medusa/src/services/user.ts:35](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L35) ___ @@ -82,7 +92,7 @@ TransactionBaseService.transactionManager\_ #### Defined in -[services/user.ts:33](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L33) +[packages/medusa/src/services/user.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L36) ___ @@ -92,7 +102,7 @@ ___ #### Defined in -[services/user.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L34) +[packages/medusa/src/services/user.ts:37](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L37) ___ @@ -104,11 +114,14 @@ ___ | Name | Type | | :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | | `PASSWORD_RESET` | `string` | +| `UPDATED` | `string` | #### Defined in -[services/user.ts:28](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L28) +[packages/medusa/src/services/user.ts:28](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L28) ## Methods @@ -116,6 +129,10 @@ ___ ▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + #### Type parameters | Name | @@ -127,21 +144,23 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | | -| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | -| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | #### Returns `Promise`<`TResult`\> +the result of the transactional work + #### Inherited from TransactionBaseService.atomicPhase\_ #### Defined in -[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53) +[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53) ___ @@ -149,20 +168,25 @@ ___ ▸ **create**(`user`, `password`): `Promise`<`User`\> +Creates a user with username being validated. +Fails if email is not a valid format. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `user` | `CreateUserInput` | | -| `password` | `string` | | +| `user` | `CreateUserInput` | the user to create | +| `password` | `string` | user's password to hash | #### Returns `Promise`<`User`\> +the result of create + #### Defined in -[services/user.ts:183](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L183) +[packages/medusa/src/services/user.ts:176](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L176) ___ @@ -170,19 +194,23 @@ ___ ▸ **delete**(`userId`): `Promise`<`void`\> +Deletes a user from a given user id. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `userId` | `string` | | +| `userId` | `string` | the id of the user to delete. Must be castable as an ObjectId | #### Returns `Promise`<`void`\> +the result of the delete operation. + #### Defined in -[services/user.ts:251](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L251) +[packages/medusa/src/services/user.ts:256](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L256) ___ @@ -190,19 +218,27 @@ ___ ▸ **generateResetPasswordToken**(`userId`): `Promise`<`string`\> +Generate a JSON Web token, that will be sent to a user, that wishes to +reset password. +The token will be signed with the users current password hash as a secret +a long side a payload with userId and the expiry time for the token, which +is always 15 minutes. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `userId` | `string` | | +| `userId` | `string` | the id of the user to reset password for | #### Returns `Promise`<`string`\> +the generated JSON web token + #### Defined in -[services/user.ts:305](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L305) +[packages/medusa/src/services/user.ts:312](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L312) ___ @@ -210,19 +246,23 @@ ___ ▸ **hashPassword_**(`password`): `Promise`<`string`\> +Hashes a password + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `password` | `string` | | +| `password` | `string` | the value to hash | #### Returns `Promise`<`string`\> +hashed password + #### Defined in -[services/user.ts:171](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L171) +[packages/medusa/src/services/user.ts:164](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L164) ___ @@ -234,16 +274,18 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `selector` | `FilterableUserProps` | | -| `config` | `Object` | | +| `selector` | `FilterableUserProps` | the query object for find | +| `config` | `Object` | the configuration object for the query | #### Returns `Promise`<`User`[]\> +the result of the find operation + #### Defined in -[services/user.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L68) +[packages/medusa/src/services/user.ts:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L73) ___ @@ -251,20 +293,25 @@ ___ ▸ **retrieve**(`userId`, `config?`): `Promise`<`User`\> +Gets a user by id. +Throws in case of DB Error and if user was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `userId` | `string` | | -| `config` | `FindConfig`<`User`\> | | +| `userId` | `string` | the id of the user to get. | +| `config` | `FindConfig`<`User`\> | query configs | #### Returns `Promise`<`User`\> +the user document. + #### Defined in -[services/user.ts:84](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L84) +[packages/medusa/src/services/user.ts:86](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L86) ___ @@ -272,20 +319,25 @@ ___ ▸ **retrieveByApiToken**(`apiToken`, `relations?`): `Promise`<`User`\> +Gets a user by api token. +Throws in case of DB Error and if user was not found. + #### Parameters | Name | Type | Default value | Description | | :------ | :------ | :------ | :------ | -| `apiToken` | `string` | `undefined` | | -| `relations` | `string`[] | `[]` | | +| `apiToken` | `string` | `undefined` | the token of the user to get. | +| `relations` | `string`[] | `[]` | relations to include with the user | #### Returns `Promise`<`User`\> +the user document. + #### Defined in -[services/user.ts:111](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L111) +[packages/medusa/src/services/user.ts:110](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L110) ___ @@ -293,20 +345,25 @@ ___ ▸ **retrieveByEmail**(`email`, `config?`): `Promise`<`User`\> +Gets a user by email. +Throws in case of DB Error and if user was not found. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `email` | `string` | | -| `config` | `FindConfig`<`User`\> | | +| `email` | `string` | the email of the user to get. | +| `config` | `FindConfig`<`User`\> | query config | #### Returns `Promise`<`User`\> +the user document. + #### Defined in -[services/user.ts:143](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L143) +[packages/medusa/src/services/user.ts:139](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L139) ___ @@ -314,20 +371,26 @@ ___ ▸ **setPassword_**(`userId`, `password`): `Promise`<`User`\> +Sets a password for a user +Fails if no user exists with userId and if the hashing of the new +password does not work. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `userId` | `string` | | -| `password` | `string` | | +| `userId` | `string` | the userId to set password for | +| `password` | `string` | the old password to set | #### Returns `Promise`<`User`\> +the result of the update operation + #### Defined in -[services/user.ts:276](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L276) +[packages/medusa/src/services/user.ts:283](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L283) ___ @@ -351,7 +414,7 @@ TransactionBaseService.shouldRetryTransaction\_ #### Defined in -[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34) +[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34) ___ @@ -359,20 +422,24 @@ ___ ▸ **update**(`userId`, `update`): `Promise`<`User`\> +Updates a user. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `userId` | `string` | | -| `update` | `UpdateUserInput` | | +| `userId` | `string` | id of the user to update | +| `update` | `UpdateUserInput` | the values to be updated on the user | #### Returns `Promise`<`User`\> +the result of create + #### Defined in -[services/user.ts:211](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L211) +[packages/medusa/src/services/user.ts:210](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L210) ___ @@ -380,19 +447,23 @@ ___ ▸ **validateEmail_**(`email`): `string` +Used to validate user email. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `email` | `string` | | +| `email` | `string` | email to validate | #### Returns `string` +the validated email + #### Defined in -[services/user.ts:50](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/user.ts#L50) +[packages/medusa/src/services/user.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/user.ts#L53) ___ @@ -416,4 +487,4 @@ TransactionBaseService.withTransaction #### Defined in -[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16) +[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16) diff --git a/package.json b/package.json index 96cd48f6a5..de6d1d82fc 100644 --- a/package.json +++ b/package.json @@ -41,11 +41,11 @@ "resolve-cwd": "^3.0.0", "ts-jest": "^26.5.6", "turbo": "^1.3.1", - "typedoc": "^0.22.15", + "typedoc": "0.23.10", "typedoc-frontmatter-plugin": "link:docs-util/typedoc-plugins/typedoc-frontmatter-plugin", "typedoc-monorepo-link-types": "^0.0.2", - "typedoc-plugin-markdown": "^3.12.1", - "typedoc-plugin-merge-modules": "^3.1.0", + "typedoc-plugin-markdown": "^3.13.4", + "typedoc-plugin-merge-modules": "^4.0.1", "typedoc-plugin-reference-excluder": "^1.0.0", "typeorm": "^0.2.31" }, diff --git a/packages/medusa/src/services/sales-channel.ts b/packages/medusa/src/services/sales-channel.ts index 0de3a2a594..90d32d104a 100644 --- a/packages/medusa/src/services/sales-channel.ts +++ b/packages/medusa/src/services/sales-channel.ts @@ -1,17 +1,17 @@ -import { MedusaError } from "medusa-core-utils" -import { EntityManager } from "typeorm" - -import { TransactionBaseService } from "../interfaces" -import { SalesChannel } from "../models" -import { SalesChannelRepository } from "../repositories/sales-channel" -import { FindConfig, QuerySelector } from "../types/common" import { CreateSalesChannelInput, UpdateSalesChannelInput, } from "../types/sales-channels" -import { buildQuery } from "../utils" +import { FindConfig, QuerySelector } from "../types/common" + +import { EntityManager } from "typeorm" import EventBusService from "./event-bus" +import { MedusaError } from "medusa-core-utils" +import { SalesChannel } from "../models" +import { SalesChannelRepository } from "../repositories/sales-channel" import StoreService from "./store" +import { TransactionBaseService } from "../interfaces" +import { buildQuery } from "../utils" type InjectedDependencies = { salesChannelRepository: typeof SalesChannelRepository @@ -181,7 +181,6 @@ class SalesChannelService extends TransactionBaseService { * @experimental This feature is under development and may change in the future. * To use this feature please enable the corresponding feature flag in your medusa backend project. * @param salesChannelId - the id of the sales channel to delete - * @return Promise */ async delete(salesChannelId: string): Promise { return await this.atomicPhase_(async (transactionManager) => { diff --git a/typedoc.js-client.js b/typedoc.js-client.js index 8ab54c6ab4..335c104e3c 100644 --- a/typedoc.js-client.js +++ b/typedoc.js-client.js @@ -18,7 +18,11 @@ module.exports = { "typedoc-monorepo-link-types", "typedoc-frontmatter-plugin", ], - exclude: "packages/medusa-js/src/resources/base.ts", + exclude: [ + "packages/medusa-js/src/resources/base.ts", + "node_modules/**", + "packages/**/node_modules", + ], excludeConstructors: true, frontmatterData: { displayed_sidebar: "jsClientSidebar", diff --git a/yarn.lock b/yarn.lock index 5799671e69..a35b2b1fac 100644 --- a/yarn.lock +++ b/yarn.lock @@ -19017,7 +19017,7 @@ __metadata: languageName: node linkType: hard -"glob@npm:^8.0.1, glob@npm:^8.0.3": +"glob@npm:^8.0.1": version: 8.0.3 resolution: "glob@npm:8.0.3" dependencies: @@ -24804,7 +24804,7 @@ __metadata: languageName: node linkType: hard -"marked@npm:^4.0.16": +"marked@npm:^4.0.18": version: 4.0.18 resolution: "marked@npm:4.0.18" bin: @@ -31916,11 +31916,11 @@ __metadata: swagger-inline: ^3.2.2 ts-jest: ^26.5.6 turbo: ^1.3.1 - typedoc: ^0.22.15 + typedoc: 0.23.10 typedoc-frontmatter-plugin: "link:docs-util/typedoc-plugins/typedoc-frontmatter-plugin" typedoc-monorepo-link-types: ^0.0.2 - typedoc-plugin-markdown: ^3.12.1 - typedoc-plugin-merge-modules: ^3.1.0 + typedoc-plugin-markdown: ^3.13.4 + typedoc-plugin-merge-modules: ^4.0.1 typedoc-plugin-reference-excluder: ^1.0.0 typeorm: ^0.2.31 languageName: unknown @@ -35396,23 +35396,23 @@ __metadata: languageName: node linkType: hard -"typedoc-plugin-markdown@npm:^3.12.1": - version: 3.13.3 - resolution: "typedoc-plugin-markdown@npm:3.13.3" +"typedoc-plugin-markdown@npm:^3.13.4": + version: 3.13.4 + resolution: "typedoc-plugin-markdown@npm:3.13.4" dependencies: handlebars: ^4.7.7 peerDependencies: typedoc: ">=0.23.0" - checksum: 08c57d3edc7c9c51684a90cc6ba65dace5d9e9a88e181cfbc3170d010017d62e8e33d830e9f0e8d23235735d5fcb8a43e82d2508926dacc205336b4cb88ecea9 + checksum: 9c16ed14f0092000d0c93c1cd246b60da49e88ee8aee6616a36212d472ee2c7e46169d51fed76240e4a8d6d4c27ac51f7a43c543f6da2a9129aca17b2155a561 languageName: node linkType: hard -"typedoc-plugin-merge-modules@npm:^3.1.0": - version: 3.1.0 - resolution: "typedoc-plugin-merge-modules@npm:3.1.0" +"typedoc-plugin-merge-modules@npm:^4.0.1": + version: 4.0.1 + resolution: "typedoc-plugin-merge-modules@npm:4.0.1" peerDependencies: - typedoc: 0.21.x || 0.22.x - checksum: a7747c6a98364f8210f3b5e18f3a9baa006062b64c7dd95ba4ad22656a7bcf163e4a3a7535bad59b46c20fe1a118066c4ebb96ddc61985cd0d8a5cb339d17ff9 + typedoc: 0.23.x + checksum: 5d8165cbdf0e13b3543736be25234572aa7e8ba094c52319b2849bde80ab6b6f968882fa4dbc2cdc959c676f53b17cec6dc6dfeff51396fdd92d7f2bbf522c20 languageName: node linkType: hard @@ -35425,20 +35425,19 @@ __metadata: languageName: node linkType: hard -"typedoc@npm:^0.22.15": - version: 0.22.18 - resolution: "typedoc@npm:0.22.18" +"typedoc@npm:0.23.10": + version: 0.23.10 + resolution: "typedoc@npm:0.23.10" dependencies: - glob: ^8.0.3 lunr: ^2.3.9 - marked: ^4.0.16 + marked: ^4.0.18 minimatch: ^5.1.0 shiki: ^0.10.1 peerDependencies: - typescript: 4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x || 4.5.x || 4.6.x || 4.7.x + typescript: 4.6.x || 4.7.x bin: typedoc: bin/typedoc - checksum: 57c1e375f5b4e2ebf9ea256707acd5f069027fb040371529dec29cd67de28e633a55ebccfa8eb1960dd0d308af351529be0d2ee9d0b994a0d74604b8e6bcab5b + checksum: 634e805a608c699811a0fa10944823504f0023afd599037298700179f2293cd717a937b32cf885c6bcf4808334f3132aaa9c946e63b9131789a9a9b240cb0115 languageName: node linkType: hard