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

docs: update override price selection strategy documentation (#5438)

Browse Source 
* docs: update override price selection strategy documentation

* fix eslint errors
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-10-20 20:17:45 +03:00
1 parent 8bc902fb0f
commit 1a10822cae
540 files changed
+244366 -18865
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/js-client/index.md → www/apps/docs/content/references/js-client/_index.mdx
View File
File renamed without changes.
www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addAddress
▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
**addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Adds an address to a customers saved addresses
@@ -65,7 +65,7 @@ ___
### deleteAddress
▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
**deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Deletes an address of a customer
@@ -118,7 +118,7 @@ ___
### updateAddress
▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
**updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Update an address of a customer
www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx
+1 -1
View File
@@ -17,7 +17,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Record
Ƭ **Record**<`K`, `T`\>: { [P in K]: T }
**Record**<`K`, `T`\>: { [P in K]: T }
Construct a type with a set of properties K of type T
www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx
+4 -4
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### createSession
▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\>
**createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### deleteSession
▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\>
**deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\>
#### Parameters
@@ -105,7 +105,7 @@ ___
### getSession
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\>
**getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\>
#### Parameters
@@ -153,7 +153,7 @@ ___
### getToken
▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBearerAuthRes`](../modules/admin_auth.internal.mdx#adminbearerauthres)\>
**getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBearerAuthRes`](../modules/admin_auth.internal.mdx#adminbearerauthres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx
+5 -5
View File
@@ -21,7 +21,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminAuthRes
Ƭ **AdminAuthRes**: `Object`
**AdminAuthRes**: `Object`
#### Schema
@@ -51,7 +51,7 @@ ___
### AdminBearerAuthRes
Ƭ **AdminBearerAuthRes**: `Object`
**AdminBearerAuthRes**: `Object`
#### Schema
@@ -79,7 +79,7 @@ ___
### Exclude
Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T`
**Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T`
Exclude from T those types that are assignable to U
@@ -108,7 +108,7 @@ ___
### Omit
Ƭ **Omit**<`T`, `K`\>: [`Pick`](admin_auth.internal.mdx#pick)<`T`, [`Exclude`](admin_auth.internal.mdx#exclude)<keyof `T`, `K`\>\>
**Omit**<`T`, `K`\>: [`Pick`](admin_auth.internal.mdx#pick)<`T`, [`Exclude`](admin_auth.internal.mdx#exclude)<keyof `T`, `K`\>\>
Construct a type with the properties of T except for those in type K.
@@ -137,7 +137,7 @@ ___
### Pick
Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] }
**Pick**<`T`, `K`\>: { [P in K]: T[P] }
From T, pick a set of properties whose keys are in the union K
www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### cancel
▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\>
**cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\>
#### Parameters
@@ -63,7 +63,7 @@ ___
### confirm
▸ **confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\>
**confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\>
#### Parameters
@@ -114,7 +114,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\>
#### Parameters
@@ -165,7 +165,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobListRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjoblistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobListRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjoblistres)\>
#### Parameters
@@ -216,7 +216,7 @@ ___
### retrieve
▸ **retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\>
**retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx
+5 -5
View File
@@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminBatchJobListRes
Ƭ **AdminBatchJobListRes**: [`PaginatedResponse`](admin_batch_jobs.internal.mdx#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../../internal/classes/admin_batch_jobs.internal.BatchJob.mdx)[] }
**AdminBatchJobListRes**: [`PaginatedResponse`](admin_batch_jobs.internal.mdx#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../../internal/classes/admin_batch_jobs.internal.BatchJob.mdx)[] }
#### Schema
@@ -53,7 +53,7 @@ ___
### AdminBatchJobRes
Ƭ **AdminBatchJobRes**: `Object`
**AdminBatchJobRes**: `Object`
#### Schema
@@ -83,7 +83,7 @@ ___
### BatchJobResultError
Ƭ **BatchJobResultError**: `Object`
**BatchJobResultError**: `Object`
#### Index signature
@@ -114,7 +114,7 @@ ___
### BatchJobResultStatDescriptor
Ƭ **BatchJobResultStatDescriptor**: `Object`
**BatchJobResultStatDescriptor**: `Object`
#### Type declaration
@@ -149,7 +149,7 @@ ___
### PaginatedResponse
Ƭ **PaginatedResponse**: `Object`
**PaginatedResponse**: `Object`
#### Type declaration
www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx
+7 -7
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addProducts
▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
**addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
#### Parameters
@@ -75,7 +75,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
#### Parameters
@@ -130,7 +130,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -185,7 +185,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\>
#### Parameters
@@ -240,7 +240,7 @@ ___
### removeProducts
▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\>
**removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\>
#### Parameters
@@ -303,7 +303,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
#### Parameters
@@ -358,7 +358,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx
+5 -5
View File
@@ -109,13 +109,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### ORDER\_EDIT
• **ORDER\_EDIT**: ``"order_edit"``
**ORDER\_EDIT**: ``"order_edit"``
## Type Aliases
### AdminCollectionsListRes
Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] }
**AdminCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] }
#### Schema
@@ -146,7 +146,7 @@ ___
### AdminCollectionsRes
Ƭ **AdminCollectionsRes**: `Object`
**AdminCollectionsRes**: `Object`
#### Schema
@@ -180,7 +180,7 @@ ___
### AdminDeleteProductsFromCollectionRes
Ƭ **AdminDeleteProductsFromCollectionRes**: `Object`
**AdminDeleteProductsFromCollectionRes**: `Object`
#### Schema
@@ -219,7 +219,7 @@ The ID of the collection
### Boolean
▸ **Boolean**<`T`\>(`value?`): `boolean`
**Boolean**<`T`\>(`value?`): `boolean`
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/admin_currencies/classes/admin_currencies.AdminCurrenciesResource.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesListRes`](../modules/admin_currencies.internal.mdx#admincurrencieslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesListRes`](../modules/admin_currencies.internal.mdx#admincurrencieslistres)\>
#### Parameters
@@ -69,7 +69,7 @@ ___
### update
▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\>
**update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx
+2 -2
View File
@@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminCurrenciesListRes
Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] }
**AdminCurrenciesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] }
#### Schema
@@ -47,7 +47,7 @@ ___
### AdminCurrenciesRes
Ƭ **AdminCurrenciesRes**: `Object`
**AdminCurrenciesRes**: `Object`
#### Schema
www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### delete
▸ **delete**<`TResponse`\>(`path`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\>
**delete**<`TResponse`\>(`path`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\>
<ParameterTypes parameters={[
{
@@ -73,7 +73,7 @@ ___
### get
▸ **get**<`TQuery`, `TResponse`\>(`path`, `query?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\>
**get**<`TQuery`, `TResponse`\>(`path`, `query?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\>
<ParameterTypes parameters={[
{
@@ -150,7 +150,7 @@ ___
### post
▸ **post**<`TPayload`, `TResponse`\>(`path`, `payload?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\>
**post**<`TPayload`, `TResponse`\>(`path`, `payload?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\>
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/admin_customer_groups/classes/admin_customer_groups.AdminCustomerGroupsResource.mdx
+8 -8
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addCustomers
▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
**addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
Add multiple customers to a customer group.
@@ -73,7 +73,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
Create a customer group.
@@ -126,7 +126,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
Deletes a customer group.
@@ -179,7 +179,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupslistres)\>
Lists customer groups.
@@ -232,7 +232,7 @@ ___
### listCustomers
▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../../admin_customers/modules/admin_customers.internal.mdx#admincustomerslistres)\>
**listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../../admin_customers/modules/admin_customers.internal.mdx#admincustomerslistres)\>
List and count customers that belong to provided customer groups.
@@ -293,7 +293,7 @@ ___
### removeCustomers
▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
**removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
Remove multiple customers from a customer group.
@@ -354,7 +354,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
Retrieves a customer group.
@@ -415,7 +415,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\>
Updates a customer group
www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx
+2 -2
View File
@@ -23,7 +23,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminCustomerGroupsListRes
Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)[] }
**AdminCustomerGroupsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)[] }
#### Schema
@@ -54,7 +54,7 @@ ___
### AdminCustomerGroupsRes
Ƭ **AdminCustomerGroupsRes**: `Object`
**AdminCustomerGroupsRes**: `Object`
#### Schema
www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx
+4 -4
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\>
Creates a customer
@@ -65,7 +65,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../modules/admin_customers.internal.mdx#admincustomerslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../modules/admin_customers.internal.mdx#admincustomerslistres)\>
Lists customers
@@ -118,7 +118,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\>
Retrieves a customer
@@ -171,7 +171,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\>
Updates a customer
www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx
+2 -2
View File
@@ -18,7 +18,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminCustomersListRes
Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] }
**AdminCustomersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] }
#### Schema
@@ -28,7 +28,7 @@ ___
### AdminCustomersRes
Ƭ **AdminCustomersRes**: `Object`
**AdminCustomersRes**: `Object`
#### Schema
www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx
+16 -16
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addConditionResourceBatch
▸ **addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -91,7 +91,7 @@ ___
### addRegion
▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -154,7 +154,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -209,7 +209,7 @@ ___
### createCondition
▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -280,7 +280,7 @@ ___
### createDynamicCode
▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -343,7 +343,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -398,7 +398,7 @@ ___
### deleteCondition
▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -461,7 +461,7 @@ ___
### deleteConditionResourceBatch
▸ **deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -532,7 +532,7 @@ ___
### deleteDynamicCode
▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -595,7 +595,7 @@ ___
### getCondition
▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountConditionsRes`](../modules/admin_discounts.internal.mdx#admindiscountconditionsres)\>
**getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountConditionsRes`](../modules/admin_discounts.internal.mdx#admindiscountconditionsres)\>
#### Parameters
@@ -666,7 +666,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsListRes`](../modules/admin_discounts.internal.mdx#admindiscountslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsListRes`](../modules/admin_discounts.internal.mdx#admindiscountslistres)\>
#### Parameters
@@ -721,7 +721,7 @@ ___
### removeRegion
▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -784,7 +784,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -839,7 +839,7 @@ ___
### retrieveByCode
▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -894,7 +894,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
@@ -957,7 +957,7 @@ ___
### updateCondition
▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
**updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx
+384 -384
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx
+9 -9
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addLineItem
▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
**addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
#### Parameters
@@ -75,7 +75,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
#### Parameters
@@ -130,7 +130,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -185,7 +185,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftorderslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftorderslistres)\>
#### Parameters
@@ -240,7 +240,7 @@ ___
### markPaid
▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpostdraftordersdraftorderregisterpaymentres)\>
**markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpostdraftordersdraftorderregisterpaymentres)\>
#### Parameters
@@ -295,7 +295,7 @@ ___
### removeLineItem
▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
**removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
#### Parameters
@@ -358,7 +358,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
#### Parameters
@@ -413,7 +413,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
#### Parameters
@@ -476,7 +476,7 @@ ___
### updateLineItem
▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
**updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardslistres)\>
#### Parameters
@@ -177,7 +177,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\>
#### Parameters
@@ -232,7 +232,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx
+9 -9
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
**create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
Create an Inventory Item
This feature is under development and may change in the future.
@@ -79,7 +79,7 @@ ___
### createLocationLevel
▸ **createLocationLevel**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
**createLocationLevel**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
Create stock for an Inventory Item at a Stock Location
This feature is under development and may change in the future.
@@ -154,7 +154,7 @@ ___
### delete
▸ **delete**(`inventoryItemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`inventoryItemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
Delete an Inventory Item
This feature is under development and may change in the future.
@@ -213,7 +213,7 @@ ___
### deleteLocationLevel
▸ **deleteLocationLevel**(`inventoryItemId`, `locationId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
**deleteLocationLevel**(`inventoryItemId`, `locationId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
Removes an Inventory Item from a Stock Location. This erases trace of any quantity currently at the location.
This feature is under development and may change in the future.
@@ -288,7 +288,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslistwithvariantsandlocationlevelsres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslistwithvariantsandlocationlevelsres)\>
Retrieve a list of Inventory Items
This feature is under development and may change in the future.
@@ -347,7 +347,7 @@ ___
### listLocationLevels
▸ **listLocationLevels**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslocationlevelsres)\>
**listLocationLevels**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslocationlevelsres)\>
Retrieve a list of Inventory Levels related to an Inventory Item across Stock Locations
This feature is under development and may change in the future.
@@ -414,7 +414,7 @@ ___
### retrieve
▸ **retrieve**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
**retrieve**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
Retrieve an Inventory Item
This feature is under development and may change in the future.
@@ -481,7 +481,7 @@ ___
### update
▸ **update**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
**update**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
Update an Inventory Item
This feature is under development and may change in the future.
@@ -556,7 +556,7 @@ ___
### updateLocationLevel
▸ **updateLocationLevel**(`inventoryItemId`, `locationId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
**updateLocationLevel**(`inventoryItemId`, `locationId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\>
Update an Inventory Item's stock level at a Stock Location
This feature is under development and may change in the future.
www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### accept
▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
**accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
#### Parameters
@@ -54,7 +54,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
#### Parameters
@@ -96,7 +96,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -147,7 +147,7 @@ ___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminListInvitesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminlistinvitesres)\>
**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminListInvitesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminlistinvitesres)\>
#### Parameters
@@ -190,7 +190,7 @@ ___
### resend
▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
**resend**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
#### Parameters
www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx
+2 -2
View File
@@ -10,10 +10,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminPostInvitesPayload
Ƭ **AdminPostInvitesPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminPostInvitesReq`](../../internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](admin_invites.internal.mdx#inviteuserrolesenum) }
**AdminPostInvitesPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminPostInvitesReq`](../../internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](admin_invites.internal.mdx#inviteuserrolesenum) }
___
### InviteUserRolesEnum
Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\`
**InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\`
www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\>
#### Parameters
@@ -63,7 +63,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -114,7 +114,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnoteslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnoteslistres)\>
#### Parameters
@@ -165,7 +165,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\>
#### Parameters
@@ -216,7 +216,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationslistres)\>
#### Parameters
@@ -63,7 +63,7 @@ ___
### resend
▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationsres)\>
**resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx
+12 -12
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addLineItem
▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
@@ -71,7 +71,7 @@ ___
### cancel
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### confirm
▸ **confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
@@ -173,7 +173,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
@@ -224,7 +224,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -275,7 +275,7 @@ ___
### deleteItemChange
▸ **deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderedititemchangedeleteres)\>
**deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderedititemchangedeleteres)\>
#### Parameters
@@ -334,7 +334,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditslistres)\>
#### Parameters
@@ -385,7 +385,7 @@ ___
### removeLineItem
▸ **removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
@@ -444,7 +444,7 @@ ___
### requestConfirmation
▸ **requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
@@ -495,7 +495,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
@@ -554,7 +554,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
@@ -613,7 +613,7 @@ ___
### updateLineItem
▸ **updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
**updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx
+25 -25
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addShippingMethod
▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -71,7 +71,7 @@ ___
### archive
▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**archive**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### cancel
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -173,7 +173,7 @@ ___
### cancelClaim
▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -232,7 +232,7 @@ ___
### cancelClaimFulfillment
▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -299,7 +299,7 @@ ___
### cancelFulfillment
▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -358,7 +358,7 @@ ___
### cancelSwap
▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -417,7 +417,7 @@ ___
### cancelSwapFulfillment
▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -484,7 +484,7 @@ ___
### capturePayment
▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -535,7 +535,7 @@ ___
### complete
▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**complete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -586,7 +586,7 @@ ___
### createClaim
▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -645,7 +645,7 @@ ___
### createClaimShipment
▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -712,7 +712,7 @@ ___
### createFulfillment
▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -771,7 +771,7 @@ ___
### createShipment
▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -830,7 +830,7 @@ ___
### createSwap
▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -889,7 +889,7 @@ ___
### createSwapShipment
▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -956,7 +956,7 @@ ___
### fulfillClaim
▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -1023,7 +1023,7 @@ ___
### fulfillSwap
▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -1090,7 +1090,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderslistres)\>
#### Parameters
@@ -1141,7 +1141,7 @@ ___
### processSwapPayment
▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -1200,7 +1200,7 @@ ___
### refundPayment
▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -1259,7 +1259,7 @@ ___
### requestReturn
▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -1318,7 +1318,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -1377,7 +1377,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
@@ -1436,7 +1436,7 @@ ___
### updateClaim
▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
**updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx
+4 -4
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectiondeleteres)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectiondeleteres)\>
#### Parameters
@@ -63,7 +63,7 @@ ___
### markAsAuthorized
▸ **markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\>
**markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\>
#### Parameters
@@ -114,7 +114,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\>
**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\>
#### Parameters
@@ -173,7 +173,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### capturePayment
▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\>
**capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\>
#### Parameters
@@ -63,7 +63,7 @@ ___
### refundPayment
▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRefundRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminrefundres)\>
**refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRefundRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminrefundres)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\>
**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx
+11 -11
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addPrices
▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\>
**addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\>
#### Parameters
@@ -71,7 +71,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -173,7 +173,7 @@ ___
### deletePrices
▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\>
**deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\>
#### Parameters
@@ -232,7 +232,7 @@ ___
### deleteProductPrices
▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\>
**deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\>
#### Parameters
@@ -291,7 +291,7 @@ ___
### deleteProductsPrices
▸ **deleteProductsPrices**(`priceListId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\>
**deleteProductsPrices**(`priceListId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\>
#### Parameters
@@ -350,7 +350,7 @@ ___
### deleteVariantPrices
▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\>
**deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\>
#### Parameters
@@ -409,7 +409,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistslistres)\>
#### Parameters
@@ -460,7 +460,7 @@ ___
### listProducts
▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`any`\>
**listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`any`\>
#### Parameters
@@ -519,7 +519,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\>
#### Parameters
@@ -570,7 +570,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx
+7 -7
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addProducts
▸ **addProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
**addProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
Add products to a product category
This feature is under development and may change in the future.
@@ -79,7 +79,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
#### Parameters
@@ -130,7 +130,7 @@ ___
### delete
▸ **delete**(`productCategoryId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`productCategoryId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
Delete a product category
This feature is under development and may change in the future.
@@ -189,7 +189,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategorieslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategorieslistres)\>
Retrieve a list of product categories
This feature is under development and may change in the future.
@@ -248,7 +248,7 @@ ___
### removeProducts
▸ **removeProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
**removeProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
Remove products from a product category
This feature is under development and may change in the future.
@@ -315,7 +315,7 @@ ___
### retrieve
▸ **retrieve**(`productCategoryId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
**retrieve**(`productCategoryId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
retrieve a product category
This feature is under development and may change in the future.
@@ -382,7 +382,7 @@ ___
### update
▸ **update**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
**update**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\>
update a product category
This feature is under development and may change in the future.
www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### list
▸ **list**(`query?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttagslistres)\>
**list**(`query?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttagslistres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttypeslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttypeslistres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx
+14 -14
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addOption
▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
**addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
#### Parameters
@@ -71,7 +71,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### createVariant
▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
**createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
#### Parameters
@@ -181,7 +181,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteres)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteres)\>
#### Parameters
@@ -232,7 +232,7 @@ ___
### deleteOption
▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteOptionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteoptionres)\>
**deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteOptionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteoptionres)\>
#### Parameters
@@ -291,7 +291,7 @@ ___
### deleteVariant
▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteVariantRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeletevariantres)\>
**deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteVariantRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeletevariantres)\>
#### Parameters
@@ -350,7 +350,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslistres)\>
#### Parameters
@@ -401,7 +401,7 @@ ___
### listTags
▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTagsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttagsres)\>
**listTags**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTagsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttagsres)\>
#### Parameters
@@ -444,7 +444,7 @@ ___
### listTypes
▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTypesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttypesres)\>
**listTypes**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTypesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttypesres)\>
#### Parameters
@@ -491,7 +491,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
#### Parameters
@@ -542,7 +542,7 @@ ___
### setMetadata
▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
**setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
#### Parameters
@@ -601,7 +601,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
#### Parameters
@@ -660,7 +660,7 @@ ___
### updateOption
▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
**updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
#### Parameters
@@ -727,7 +727,7 @@ ___
### updateVariant
▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
**updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx
+9 -9
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addSalesChannelsBatch
▸ **addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
**addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
#### Parameters
@@ -71,7 +71,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -173,7 +173,7 @@ ___
### deleteSalesChannelsBatch
▸ **deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
**deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
#### Parameters
@@ -232,7 +232,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeyslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeyslistres)\>
#### Parameters
@@ -283,7 +283,7 @@ ___
### listSalesChannels
▸ **listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\>
**listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\>
#### Parameters
@@ -342,7 +342,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
#### Parameters
@@ -401,7 +401,7 @@ ___
### revoke
▸ **revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
**revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\>
#### Parameters
@@ -452,7 +452,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\>
**update**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\>
#### Parameters
www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx
+12 -12
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addCountry
▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
@@ -75,7 +75,7 @@ ___
### addFulfillmentProvider
▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
@@ -138,7 +138,7 @@ ___
### addPaymentProvider
▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
@@ -201,7 +201,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
@@ -256,7 +256,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -311,7 +311,7 @@ ___
### deleteCountry
▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
@@ -374,7 +374,7 @@ ___
### deleteFulfillmentProvider
▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
@@ -437,7 +437,7 @@ ___
### deletePaymentProvider
▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
@@ -500,7 +500,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminregionslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminregionslistres)\>
#### Parameters
@@ -555,7 +555,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
@@ -610,7 +610,7 @@ ___
### retrieveFulfillmentOptions
▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)\>
**retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)\>
#### Parameters
@@ -665,7 +665,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\>
create a reservation
@@ -71,7 +71,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
remove a reservation
@@ -130,7 +130,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationslistres)\>
List reservations
This feature is under development and may change in the future.
@@ -189,7 +189,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\>
Get a reservation
This feature is under development and may change in the future.
@@ -248,7 +248,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\>
update a reservation
www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonslistres)\>
**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonslistres)\>
#### Parameters
@@ -169,7 +169,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\>
#### Parameters
@@ -224,7 +224,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### cancel
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsCancelRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnscancelres)\>
**cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsCancelRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnscancelres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnslistres)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### receive
▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnsres)\>
**receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx
+9 -9
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addLocation
▸ **addLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
**addLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
Add a location to a sales channel
This feature is under development and may change in the future.
@@ -79,7 +79,7 @@ ___
### addProducts
▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
**addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
Add products to a sales channel
This feature is under development and may change in the future.
@@ -146,7 +146,7 @@ ___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
#### Parameters
@@ -197,7 +197,7 @@ ___
### delete
▸ **delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
Delete a sales channel
This feature is under development and may change in the future.
@@ -256,7 +256,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\>
Retrieve a list of sales channels
This feature is under development and may change in the future.
@@ -315,7 +315,7 @@ ___
### removeLocation
▸ **removeLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
**removeLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
remove a location from a sales channel
This feature is under development and may change in the future.
@@ -382,7 +382,7 @@ ___
### removeProducts
▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
**removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
Remove products from a sales channel
This feature is under development and may change in the future.
@@ -449,7 +449,7 @@ ___
### retrieve
▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
**retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
retrieve a sales channel
This feature is under development and may change in the future.
@@ -508,7 +508,7 @@ ___
### update
▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
**update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\>
update a sales channel
This feature is under development and may change in the future.
www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionslistres)\>
#### Parameters
@@ -177,7 +177,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\>
#### Parameters
@@ -232,7 +232,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\>
#### Parameters
@@ -63,7 +63,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -114,7 +114,7 @@ ___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofileslistres)\>
**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofileslistres)\>
#### Parameters
@@ -157,7 +157,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\>
#### Parameters
@@ -208,7 +208,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\>
Create a Stock Location
This feature is under development and may change in the future.
@@ -71,7 +71,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#deleteresponse)\>
Delete a Stock Location
This feature is under development and may change in the future.
@@ -130,7 +130,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationslistres)\>
Retrieve a list of Stock Locations
This feature is under development and may change in the future.
@@ -189,7 +189,7 @@ ___
### retrieve
▸ **retrieve**(`itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\>
**retrieve**(`itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\>
Retrieve a Stock Location
This feature is under development and may change in the future.
@@ -248,7 +248,7 @@ ___
### update
▸ **update**(`stockLocationId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\>
**update**(`stockLocationId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\>
Update a Stock Location
This feature is under development and may change in the future.
www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx
+6 -6
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addCurrency
▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\>
**addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### deleteCurrency
▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\>
**deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### listPaymentProviders
▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentproviderslist)\>
**listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentproviderslist)\>
#### Parameters
@@ -169,7 +169,7 @@ ___
### listTaxProviders
▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxproviderslist)\>
**listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxproviderslist)\>
#### Parameters
@@ -216,7 +216,7 @@ ___
### retrieve
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminExtendedStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminextendedstoresres)\>
**retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminExtendedStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminextendedstoresres)\>
#### Parameters
@@ -263,7 +263,7 @@ ___
### update
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\>
**update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapslistres)\>
#### Parameters
@@ -63,7 +63,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapsres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx
+11 -11
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addProductTypes
▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
@@ -79,7 +79,7 @@ ___
### addProducts
▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
@@ -146,7 +146,7 @@ ___
### addShippingOptions
▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
@@ -213,7 +213,7 @@ ___
### create
▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
@@ -272,7 +272,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -323,7 +323,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxrateslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxrateslistres)\>
#### Parameters
@@ -374,7 +374,7 @@ ___
### removeProductTypes
▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
@@ -441,7 +441,7 @@ ___
### removeProducts
▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
@@ -508,7 +508,7 @@ ___
### removeShippingOptions
▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
@@ -575,7 +575,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
@@ -634,7 +634,7 @@ ___
### update
▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
**update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx
+5 -5
View File
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_createPayload
▸ `Private` **_createPayload**(`file`): `FormData`
`Private` **_createPayload**(`file`): `FormData`
#### Parameters
@@ -58,7 +58,7 @@ ___
### create
▸ **create**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\>
**create**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\>
#### Parameters
@@ -105,7 +105,7 @@ ___
### createProtected
▸ **createProtected**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\>
**createProtected**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\>
#### Parameters
@@ -152,7 +152,7 @@ ___
### delete
▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -203,7 +203,7 @@ ___
### getPresignedDownloadUrl
▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\>
**getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx
+29 -29
View File
@@ -44,31 +44,31 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminCreateUploadPayload
Ƭ **AdminCreateUploadPayload**: [`File`](admin_uploads.internal.mdx#file) \| [`File`](admin_uploads.internal.mdx#file)[]
**AdminCreateUploadPayload**: [`File`](admin_uploads.internal.mdx#file) \| [`File`](admin_uploads.internal.mdx#file)[]
___
### BlobPart
Ƭ **BlobPart**: [`BufferSource`](admin_uploads.internal.mdx#buffersource) \| `Blob` \| `string`
**BlobPart**: [`BufferSource`](admin_uploads.internal.mdx#buffersource) \| `Blob` \| `string`
___
### BufferSource
Ƭ **BufferSource**: [`ArrayBufferView`](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx) \| `ArrayBuffer`
**BufferSource**: [`ArrayBufferView`](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx) \| `ArrayBuffer`
___
### EndingType
Ƭ **EndingType**: ``"native"`` \| ``"transparent"``
**EndingType**: ``"native"`` \| ``"transparent"``
___
### ReadableStreamController
Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`T`\> \| [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)
**ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`T`\> \| [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)
#### Type parameters
@@ -87,7 +87,7 @@ ___
### ReadableStreamReadResult
Ƭ **ReadableStreamReadResult**<`T`\>: [`ReadableStreamReadValueResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx)<`T`\> \| [`ReadableStreamReadDoneResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx)<`T`\>
**ReadableStreamReadResult**<`T`\>: [`ReadableStreamReadValueResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx)<`T`\> \| [`ReadableStreamReadDoneResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx)<`T`\>
#### Type parameters
@@ -106,7 +106,7 @@ ___
### ReadableStreamReader
Ƭ **ReadableStreamReader**<`T`\>: [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`T`\> \| [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)
**ReadableStreamReader**<`T`\>: [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`T`\> \| [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)
#### Type parameters
@@ -125,11 +125,11 @@ ___
### File
• **File**: `Object`
**File**: `Object`
#### Call signature
• **new File**(`fileBits`, `fileName`, `options?`): [`File`](admin_uploads.internal.mdx#file)
**new File**(`fileBits`, `fileName`, `options?`): [`File`](admin_uploads.internal.mdx#file)
##### Parameters
@@ -192,11 +192,11 @@ ___
### ReadableByteStreamController
• **ReadableByteStreamController**: `Object`
**ReadableByteStreamController**: `Object`
#### Call signature
• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)
**new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller)
##### Returns
@@ -230,11 +230,11 @@ ___
### ReadableStream
• **ReadableStream**: `Object`
**ReadableStream**: `Object`
#### Call signature
• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\>
**new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\>
##### Parameters
@@ -289,7 +289,7 @@ ___
}
]} />
• **new ReadableStream**<`R`\>(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\>
**new ReadableStream**<`R`\>(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\>
<ParameterTypes parameters={[
{
@@ -338,7 +338,7 @@ ___
}
]} />
• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\>
**new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\>
<ParameterTypes parameters={[
{
@@ -404,11 +404,11 @@ ___
### ReadableStreamBYOBReader
• **ReadableStreamBYOBReader**: `Object`
**ReadableStreamBYOBReader**: `Object`
#### Call signature
• **new ReadableStreamBYOBReader**(`stream`): [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)
**new ReadableStreamBYOBReader**(`stream`): [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader)
##### Parameters
@@ -455,11 +455,11 @@ ___
### ReadableStreamBYOBRequest
• **ReadableStreamBYOBRequest**: `Object`
**ReadableStreamBYOBRequest**: `Object`
#### Call signature
• **new ReadableStreamBYOBRequest**(): [`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest)
**new ReadableStreamBYOBRequest**(): [`ReadableStreamBYOBRequest`](admin_uploads.internal.mdx#readablestreambyobrequest)
##### Returns
@@ -493,11 +493,11 @@ ___
### ReadableStreamDefaultController
• **ReadableStreamDefaultController**: `Object`
**ReadableStreamDefaultController**: `Object`
#### Call signature
• **new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\>
**new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\>
##### Returns
@@ -540,11 +540,11 @@ ___
### ReadableStreamDefaultReader
• **ReadableStreamDefaultReader**: `Object`
**ReadableStreamDefaultReader**: `Object`
#### Call signature
• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\>
**new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\>
<ParameterTypes parameters={[
{
@@ -602,11 +602,11 @@ ___
### WritableStream
• **WritableStream**: `Object`
**WritableStream**: `Object`
#### Call signature
• **new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\>
**new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\>
<ParameterTypes parameters={[
{
@@ -672,11 +672,11 @@ ___
### WritableStreamDefaultController
• **WritableStreamDefaultController**: `Object`
**WritableStreamDefaultController**: `Object`
#### Call signature
• **new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller)
**new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](admin_uploads.internal.mdx#writablestreamdefaultcontroller)
##### Returns
@@ -710,11 +710,11 @@ ___
### WritableStreamDefaultWriter
• **WritableStreamDefaultWriter**: `Object`
**WritableStreamDefaultWriter**: `Object`
#### Call signature
• **new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\>
**new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\>
<ParameterTypes parameters={[
{
www/apps/docs/content/references/js-client/admin_users/classes/admin_users.AdminUsersResource.mdx
+7 -7
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\>
#### Parameters
@@ -122,7 +122,7 @@ ___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUsersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserslistres)\>
**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUsersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserslistres)\>
#### Parameters
@@ -169,7 +169,7 @@ ___
### resetPassword
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
**resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
#### Parameters
@@ -224,7 +224,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
Retrieves a given user
@@ -277,7 +277,7 @@ ___
### sendResetPasswordToken
▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\>
**sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\>
#### Parameters
@@ -323,7 +323,7 @@ ___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\>
#### Parameters
www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx
+7 -7
View File
@@ -10,31 +10,31 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### AdminCreateUserPayload
Ƭ **AdminCreateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx), ``"role"``\> \| { `role?`: [`CreateUserRoles`](admin_users.internal.mdx#createuserroles) }
**AdminCreateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx), ``"role"``\> \| { `role?`: [`CreateUserRoles`](admin_users.internal.mdx#createuserroles) }
___
### AdminUpdateUserPayload
Ƭ **AdminUpdateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx), ``"role"``\> & { `role?`: [`UpdateUserRoles`](admin_users.internal.mdx#updateuserroles) }
**AdminUpdateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx), ``"role"``\> & { `role?`: [`UpdateUserRoles`](admin_users.internal.mdx#updateuserroles) }
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
**CreateUserRoles**: \`${CreateUserRolesEnum}\`
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx)[``"role"``]\>
**CreateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx)[``"role"``]\>
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
**NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
@@ -53,10 +53,10 @@ ___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
**UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx)[``"role"``]\>
**UpdateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx)[``"role"``]\>
www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### getInventory
▸ **getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingetvariantsvariantinventoryres)\>
**getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingetvariantsvariantinventoryres)\>
#### Parameters
@@ -63,7 +63,7 @@ ___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantslistres)\>
List product variants
@@ -116,7 +116,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantsres)\>
**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantsres)\>
Get a product variant
www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx
+5 -5
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### authenticate
▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\>
**authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### deleteSession
▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\>
**deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\>
#### Parameters
@@ -105,7 +105,7 @@ ___
### exists
▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetAuthEmailRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetauthemailres)\>
**exists**(`email`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetAuthEmailRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetauthemailres)\>
#### Parameters
@@ -160,7 +160,7 @@ ___
### getSession
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\>
**getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\>
#### Parameters
@@ -208,7 +208,7 @@ ___
### getToken
▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreBearerAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storebearerauthres)\>
**getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreBearerAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storebearerauthres)\>
#### Parameters
www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx
+11 -11
View File
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### addShippingMethod
▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Adds a shipping method to cart
@@ -86,7 +86,7 @@ ___
### complete
▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCompleteCartRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecompletecartres)\>
**complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCompleteCartRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecompletecartres)\>
Completes a cart.
Payment authorization is attempted and if more work is required, we simply return the cart for further updates.
@@ -143,7 +143,7 @@ ___
### create
▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Creates a cart
@@ -196,7 +196,7 @@ ___
### createPaymentSessions
▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Creates payment sessions.
Initializes the payment sessions that can be used to pay for the items of the cart.
@@ -251,7 +251,7 @@ ___
### deleteDiscount
▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Removes a discount from cart.
@@ -312,7 +312,7 @@ ___
### deletePaymentSession
▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Removes a payment session from a cart.
Can be useful in case a payment has failed
@@ -374,7 +374,7 @@ ___
### refreshPaymentSession
▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Refreshes a payment session.
@@ -435,7 +435,7 @@ ___
### retrieve
▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Retrieves a cart
@@ -488,7 +488,7 @@ ___
### setPaymentSession
▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Refreshes a payment session.
@@ -549,7 +549,7 @@ ___
### update
▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Updates a cart
@@ -610,7 +610,7 @@ ___
### updatePaymentSession
▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
**updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\>
Updates the payment method
www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx
+2 -2
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\>
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\>
#### Parameters
@@ -67,7 +67,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\>
**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\>
#### Parameters
www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx
+6 -6
View File
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Creates a customer
@@ -86,7 +86,7 @@ ___
### generatePasswordToken
▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
**generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)
Generates a reset password token, which can be used to reset the password.
The token is not returned but should be sent out to the customer in an email.
@@ -131,7 +131,7 @@ ___
### listOrders
▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\>
**listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\>
Retrieve customer orders
@@ -184,7 +184,7 @@ ___
### resetPassword
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
**resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Resets customer password
@@ -237,7 +237,7 @@ ___
### retrieve
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
**retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Retrieves the customer that is currently logged
@@ -282,7 +282,7 @@ ___
### update
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
**update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\>
Updates a customer
www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### retrieve
▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegiftcardsres)\>
**retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegiftcardsres)\>
#### Parameters
www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx
+80 -80
View File
@@ -141,7 +141,7 @@ v0.9.4
### \_construct
▸ `Optional` **_construct**(`callback`): `void`
`Optional` **_construct**(`callback`): `void`
#### Parameters
@@ -179,7 +179,7 @@ ___
### \_destroy
▸ **_destroy**(`error`, `callback`): `void`
**_destroy**(`error`, `callback`): `void`
#### Parameters
@@ -225,7 +225,7 @@ ___
### \_final
▸ **_final**(`callback`): `void`
**_final**(`callback`): `void`
#### Parameters
@@ -263,7 +263,7 @@ ___
### \_write
▸ **_write**(`chunk`, `encoding`, `callback`): `void`
**_write**(`chunk`, `encoding`, `callback`): `void`
#### Parameters
@@ -317,7 +317,7 @@ ___
### \_writev
▸ `Optional` **_writev**(`chunks`, `callback`): `void`
`Optional` **_writev**(`chunks`, `callback`): `void`
#### Parameters
@@ -363,7 +363,7 @@ ___
### addListener
▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Event emitter
The defined events on documents including:
@@ -414,7 +414,7 @@ The defined events on documents including:
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -456,7 +456,7 @@ The defined events on documents including:
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -498,7 +498,7 @@ The defined events on documents including:
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -540,7 +540,7 @@ The defined events on documents including:
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -582,7 +582,7 @@ The defined events on documents including:
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -624,7 +624,7 @@ The defined events on documents including:
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -670,7 +670,7 @@ ___
### cork
▸ **cork**(): `void`
**cork**(): `void`
The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](../../internal/classes/admin_discounts.internal.WritableBase.mdx#uncork) or [end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) methods are called.
@@ -711,7 +711,7 @@ ___
### destroy
▸ **destroy**(`error?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**destroy**(`error?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the writable
stream has ended and subsequent calls to `write()` or `end()` will result in
@@ -766,7 +766,7 @@ ___
### emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -842,7 +842,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit)
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -876,7 +876,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit)
▸ **emit**(`event`, `err`): `boolean`
**emit**(`event`, `err`): `boolean`
#### Parameters
@@ -918,7 +918,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit)
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -952,7 +952,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit)
▸ **emit**(`event`, `src`): `boolean`
**emit**(`event`, `src`): `boolean`
#### Parameters
@@ -994,7 +994,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit)
▸ **emit**(`event`, `src`): `boolean`
**emit**(`event`, `src`): `boolean`
#### Parameters
@@ -1036,7 +1036,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit)
▸ **emit**(`event`, `...args`): `boolean`
**emit**(`event`, `...args`): `boolean`
#### Parameters
@@ -1082,7 +1082,7 @@ ___
### end
▸ **end**(`cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**end**(`cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Calling the `writable.end()` method signals that no more data will be written
to the `Writable`. The optional `chunk` and `encoding` arguments allow one
@@ -1136,7 +1136,7 @@ v0.9.4
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end)
▸ **end**(`chunk`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**end**(`chunk`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1178,7 +1178,7 @@ v0.9.4
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end)
▸ **end**(`chunk`, `encoding`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**end**(`chunk`, `encoding`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1232,7 +1232,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -1287,7 +1287,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.internal-2.Writable.mdx#defaultmaxlisteners).
@@ -1319,7 +1319,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -1373,7 +1373,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1425,7 +1425,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**off**(`eventName`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Alias for `emitter.removeListener()`.
@@ -1477,7 +1477,7 @@ ___
### on
▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -1550,7 +1550,7 @@ v0.1.101
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1592,7 +1592,7 @@ v0.1.101
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1634,7 +1634,7 @@ v0.1.101
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1676,7 +1676,7 @@ v0.1.101
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1718,7 +1718,7 @@ v0.1.101
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1760,7 +1760,7 @@ v0.1.101
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1806,7 +1806,7 @@ ___
### once
▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -1877,7 +1877,7 @@ v0.3.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1919,7 +1919,7 @@ v0.3.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -1961,7 +1961,7 @@ v0.3.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2003,7 +2003,7 @@ v0.3.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2045,7 +2045,7 @@ v0.3.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2087,7 +2087,7 @@ v0.3.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2133,7 +2133,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -2189,7 +2189,7 @@ ___
### prependListener
▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -2248,7 +2248,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2290,7 +2290,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2332,7 +2332,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2374,7 +2374,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2416,7 +2416,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2458,7 +2458,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2504,7 +2504,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -2561,7 +2561,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2603,7 +2603,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2645,7 +2645,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2687,7 +2687,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2729,7 +2729,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2771,7 +2771,7 @@ v6.0.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[prependOnceListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**prependOnceListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -2817,7 +2817,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -2887,7 +2887,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**removeAllListeners**(`event?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -2937,7 +2937,7 @@ ___
### removeListener
▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -3063,7 +3063,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -3105,7 +3105,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -3147,7 +3147,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -3189,7 +3189,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -3231,7 +3231,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -3273,7 +3273,7 @@ v0.1.26
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[removeListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**removeListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
#### Parameters
@@ -3319,7 +3319,7 @@ ___
### setDefaultEncoding
▸ **setDefaultEncoding**(`encoding`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**setDefaultEncoding**(`encoding`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream.
@@ -3363,7 +3363,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
**setMaxListeners**(`n`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -3412,7 +3412,7 @@ ___
### uncork
▸ **uncork**(): `void`
**uncork**(): `void`
The `writable.uncork()` method flushes all data buffered since [cork](../../internal/classes/admin_discounts.internal.WritableBase.mdx#cork) was called.
@@ -3472,7 +3472,7 @@ ___
### write
▸ **write**(`chunk`, `callback?`): `boolean`
**write**(`chunk`, `callback?`): `boolean`
The `writable.write()` method writes some data to the stream, and calls the
supplied `callback` once the data has been fully handled. If an error
@@ -3567,7 +3567,7 @@ v0.9.4
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[write](../../internal/classes/admin_discounts.internal.WritableBase.mdx#write)
▸ **write**(`chunk`, `encoding`, `callback?`): `boolean`
**write**(`chunk`, `encoding`, `callback?`): `boolean`
#### Parameters
@@ -3621,7 +3621,7 @@ ___
### fromWeb
▸ `Static` **fromWeb**(`writableStream`, `options?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
`Static` **fromWeb**(`writableStream`, `options?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx)
A utility method for creating a `Writable` from a web `WritableStream`.
@@ -3669,7 +3669,7 @@ ___
### getEventListeners
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
`Static` **getEventListeners**(`emitter`, `name`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -3744,7 +3744,7 @@ ___
### listenerCount
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
`Static` **listenerCount**(`emitter`, `eventName`): `number`
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -3810,7 +3810,7 @@ ___
### on
▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../../internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../../internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
```js
import { on, EventEmitter } from 'node:events';
@@ -3932,7 +3932,7 @@ ___
### once
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
@@ -4081,7 +4081,7 @@ v11.13.0, v10.16.0
[WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once-1)
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
#### Parameters
@@ -4153,7 +4153,7 @@ ___
### setMaxListeners
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
```js
import { setMaxListeners, EventEmitter } from 'node:events';
@@ -4212,7 +4212,7 @@ ___
### toWeb
▸ `Static` **toWeb**(`streamWritable`): [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\>
`Static` **toWeb**(`streamWritable`): [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\>
A utility method for creating a web `WritableStream` from a `Writable`.
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx
+4 -4
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### close
▸ **close**(): `void`
**close**(): `void`
#### Returns
@@ -33,7 +33,7 @@ ___
### hasRef
▸ **hasRef**(): `boolean`
**hasRef**(): `boolean`
#### Returns
@@ -54,7 +54,7 @@ ___
### ref
▸ **ref**(): `void`
**ref**(): `void`
#### Returns
@@ -75,7 +75,7 @@ ___
### unref
▸ **unref**(): `void`
**unref**(): `void`
#### Returns
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx
+3 -3
View File
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### construct
▸ `Optional` **construct**(`this`, `callback`): `void`
`Optional` **construct**(`this`, `callback`): `void`
#### Parameters
@@ -111,7 +111,7 @@ ___
### destroy
▸ `Optional` **destroy**(`this`, `error`, `callback`): `void`
`Optional` **destroy**(`this`, `error`, `callback`): `void`
#### Parameters
@@ -165,7 +165,7 @@ ___
### read
▸ `Optional` **read**(`this`, `size`): `void`
`Optional` **read**(`this`, `size`): `void`
#### Parameters
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx
+2 -2
View File
@@ -70,7 +70,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### construct
▸ `Optional` **construct**(`this`, `callback`): `void`
`Optional` **construct**(`this`, `callback`): `void`
#### Parameters
@@ -112,7 +112,7 @@ ___
### destroy
▸ `Optional` **destroy**(`this`, `error`, `callback`): `void`
`Optional` **destroy**(`this`, `error`, `callback`): `void`
#### Parameters
www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx
+5 -5
View File
@@ -73,7 +73,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### construct
▸ `Optional` **construct**(`this`, `callback`): `void`
`Optional` **construct**(`this`, `callback`): `void`
#### Parameters
@@ -119,7 +119,7 @@ ___
### destroy
▸ `Optional` **destroy**(`this`, `error`, `callback`): `void`
`Optional` **destroy**(`this`, `error`, `callback`): `void`
#### Parameters
@@ -173,7 +173,7 @@ ___
### final
▸ `Optional` **final**(`this`, `callback`): `void`
`Optional` **final**(`this`, `callback`): `void`
#### Parameters
@@ -215,7 +215,7 @@ ___
### write
▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void`
`Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void`
#### Parameters
@@ -273,7 +273,7 @@ ___
### writev
▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void`
`Optional` **writev**(`this`, `chunks`, `callback`): `void`
#### Parameters
www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_\_promisify\_\_
▸ **__promisify__**(`stream`, `options?`): `Promise`<`void`\>
**__promisify__**(`stream`, `options?`): `Promise`<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx
+7 -7
View File
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### \_\_promisify\_\_
▸ **__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
**__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
@@ -77,7 +77,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
▸ **__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
**__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
@@ -158,7 +158,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
▸ **__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
**__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
@@ -255,7 +255,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
**__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
@@ -368,7 +368,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
**__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\>
<ParameterTypes parameters={[
{
@@ -497,7 +497,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
▸ **__promisify__**(`streams`, `options?`): `Promise`<`void`\>
**__promisify__**(`streams`, `options?`): `Promise`<`void`\>
#### Parameters
@@ -535,7 +535,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
▸ **__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\>
**__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\>
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx
+2 -2
View File
@@ -163,7 +163,7 @@ Base abstract entity for all entities
### loadStatus
▸ **loadStatus**(): `void`
**loadStatus**(): `void`
#### Returns
@@ -184,7 +184,7 @@ ___
### toJSON
▸ **toJSON**(): [`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)
**toJSON**(): [`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)
#### Returns
www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx
+2 -2
View File
@@ -371,7 +371,7 @@ Base abstract entity for all entities
### afterUpdateOrLoad
▸ **afterUpdateOrLoad**(): `void`
**afterUpdateOrLoad**(): `void`
#### Returns
@@ -392,7 +392,7 @@ ___
### beforeUpdate
▸ **beforeUpdate**(): `void`
**beforeUpdate**(): `void`
#### Returns
www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx
+1 -1
View File
@@ -259,7 +259,7 @@ Base abstract entity for all entities
### loadStatus
▸ **loadStatus**(): `void`
**loadStatus**(): `void`
#### Returns
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx
+6 -6
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### eventToSubscribersMap
• `get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\>
`get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\>
#### Returns
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### emit
▸ `Abstract` **emit**<`T`\>(`eventName`, `data`, `options`): `Promise`<`void`\>
`Abstract` **emit**<`T`\>(`eventName`, `data`, `options`): `Promise`<`void`\>
<ParameterTypes parameters={[
{
@@ -137,7 +137,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
[IEventBusModuleService](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx).[emit](../interfaces/admin_discounts.internal.IEventBusModuleService.mdx#emit)
▸ `Abstract` **emit**<`T`\>(`data`): `Promise`<`void`\>
`Abstract` **emit**<`T`\>(`data`): `Promise`<`void`\>
<ParameterTypes parameters={[
{
@@ -186,7 +186,7 @@ ___
### storeSubscribers
▸ `Protected` **storeSubscribers**(`«destructured»`): `void`
`Protected` **storeSubscribers**(`«destructured»`): `void`
#### Parameters
@@ -244,7 +244,7 @@ ___
### subscribe
▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`AbstractEventBusModuleService`](admin_discounts.internal.AbstractEventBusModuleService.mdx)
**subscribe**(`eventName`, `subscriber`, `context?`): [`AbstractEventBusModuleService`](admin_discounts.internal.AbstractEventBusModuleService.mdx)
#### Parameters
@@ -298,7 +298,7 @@ ___
### unsubscribe
▸ **unsubscribe**(`eventName`, `subscriber`, `context`): [`AbstractEventBusModuleService`](admin_discounts.internal.AbstractEventBusModuleService.mdx)
**unsubscribe**(`eventName`, `subscriber`, `context`): [`AbstractEventBusModuleService`](admin_discounts.internal.AbstractEventBusModuleService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractSearchService.mdx
+9 -9
View File
@@ -37,7 +37,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### options
• `get` **options**(): Record<`string`, `unknown`\>
`get` **options**(): Record<`string`, `unknown`\>
#### Returns
@@ -79,7 +79,7 @@ Record<`string`, `unknown`\>
### addDocuments
▸ `Abstract` **addDocuments**(`indexName`, `documents`, `type`): `unknown`
`Abstract` **addDocuments**(`indexName`, `documents`, `type`): `unknown`
Used to index documents by the search engine provider
@@ -135,7 +135,7 @@ ___
### createIndex
▸ `Abstract` **createIndex**(`indexName`, `options`): `unknown`
`Abstract` **createIndex**(`indexName`, `options`): `unknown`
Used to create an index
@@ -183,7 +183,7 @@ ___
### deleteAllDocuments
▸ `Abstract` **deleteAllDocuments**(`indexName`): `unknown`
`Abstract` **deleteAllDocuments**(`indexName`): `unknown`
Used to delete all documents
@@ -223,7 +223,7 @@ ___
### deleteDocument
▸ `Abstract` **deleteDocument**(`indexName`, `document_id`): `unknown`
`Abstract` **deleteDocument**(`indexName`, `document_id`): `unknown`
Used to delete document
@@ -271,7 +271,7 @@ ___
### getIndex
▸ `Abstract` **getIndex**(`indexName`): `unknown`
`Abstract` **getIndex**(`indexName`): `unknown`
Used to get an index
@@ -311,7 +311,7 @@ ___
### replaceDocuments
▸ `Abstract` **replaceDocuments**(`indexName`, `documents`, `type`): `unknown`
`Abstract` **replaceDocuments**(`indexName`, `documents`, `type`): `unknown`
Used to replace documents
@@ -367,7 +367,7 @@ ___
### search
▸ `Abstract` **search**(`indexName`, `query`, `options`): `unknown`
`Abstract` **search**(`indexName`, `query`, `options`): `unknown`
Used to search for a document in an index
@@ -423,7 +423,7 @@ ___
### updateSettings
▸ `Abstract` **updateSettings**(`indexName`, `settings`): `unknown`
`Abstract` **updateSettings**(`indexName`, `settings`): `unknown`
Used to update the settings of an index
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx
+4 -4
View File
@@ -40,7 +40,7 @@ v15.7.0, v14.18.0
### arrayBuffer
▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
**arrayBuffer**(): `Promise`<`ArrayBuffer`\>
Returns a promise that fulfills with an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) containing a copy of
the `Blob` data.
@@ -68,7 +68,7 @@ ___
### slice
▸ **slice**(`start?`, `end?`, `type?`): [`Blob`](admin_discounts.internal.Blob.mdx)
**slice**(`start?`, `end?`, `type?`): [`Blob`](admin_discounts.internal.Blob.mdx)
Creates and returns a new `Blob` containing a subset of this `Blob` objects
data. The original `Blob` is not altered.
@@ -125,7 +125,7 @@ ___
### stream
▸ **stream**(): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\>
**stream**(): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\>
Returns a new `ReadableStream` that allows the content of the `Blob` to be read.
@@ -161,7 +161,7 @@ ___
### text
▸ **text**(): `Promise`<`string`\>
**text**(): `Promise`<`string`\>
Returns a promise that fulfills with the contents of the `Blob` decoded as a
UTF-8 string.
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx
+128 -128
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx
+21 -21
View File
@@ -64,7 +64,7 @@ v0.1.26
### addListener
▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
Alias for `emitter.on(eventName, listener)`.
@@ -116,7 +116,7 @@ ___
### emit
▸ **emit**(`eventName`, `...args`): `boolean`
**emit**(`eventName`, `...args`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -204,7 +204,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -259,7 +259,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.EventEmitter-1.mdx#defaultmaxlisteners).
@@ -291,7 +291,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -345,7 +345,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -397,7 +397,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
Alias for `emitter.removeListener()`.
@@ -449,7 +449,7 @@ ___
### on
▸ **on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -526,7 +526,7 @@ ___
### once
▸ **once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -601,7 +601,7 @@ ___
### prependListener
▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -664,7 +664,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -725,7 +725,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -795,7 +795,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -845,7 +845,7 @@ ___
### removeListener
▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -975,7 +975,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
**setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -1024,7 +1024,7 @@ ___
### getEventListeners
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
`Static` **getEventListeners**(`emitter`, `name`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1095,7 +1095,7 @@ ___
### listenerCount
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
`Static` **listenerCount**(`emitter`, `eventName`): `number`
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -1161,7 +1161,7 @@ ___
### on
▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
```js
import { on, EventEmitter } from 'node:events';
@@ -1283,7 +1283,7 @@ ___
### once
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
@@ -1432,7 +1432,7 @@ v11.13.0, v10.16.0
NodeJS.EventEmitter.once
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
#### Parameters
@@ -1504,7 +1504,7 @@ ___
### setMaxListeners
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
```js
import { setMaxListeners, EventEmitter } from 'node:events';
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx
+3 -3
View File
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### isFeatureEnabled
▸ **isFeatureEnabled**(`flag`): `boolean`
**isFeatureEnabled**(`flag`): `boolean`
Check if a feature flag is enabled.
There are two ways of using this method:
@@ -75,7 +75,7 @@ ___
### listFlags
▸ **listFlags**(): [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1)
**listFlags**(): [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1)
#### Returns
@@ -100,7 +100,7 @@ ___
### setFlag
▸ **setFlag**(`key`, `value`): `void`
**setFlag**(`key`, `value`): `void`
Sets a feature flag.
Flags take two shapes:
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx
+11 -11
View File
@@ -123,7 +123,7 @@ Handles Fulfillments
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -148,7 +148,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -225,7 +225,7 @@ ___
### cancelFulfillment
▸ **cancelFulfillment**(`fulfillmentOrId`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\>
**cancelFulfillment**(`fulfillmentOrId`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\>
Cancels a fulfillment with the fulfillment provider. Will decrement the
fulfillment_quantity on the line items associated with the fulfillment.
@@ -272,7 +272,7 @@ ___
### createFulfillment
▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)[]\>
**createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)[]\>
Creates an order fulfillment
If items needs to be fulfilled by different provider, we make
@@ -345,7 +345,7 @@ ___
### createShipment
▸ **createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\>
**createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\>
Creates a shipment by marking a fulfillment as shipped. Adds
tracking links and potentially more metadata.
@@ -407,7 +407,7 @@ ___
### getFulfillmentItems\_
▸ **getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx))[]\>
**getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx))[]\>
Retrieves the order line items, given an array of items.
@@ -469,7 +469,7 @@ ___
### partitionItems\_
▸ **partitionItems_**(`shippingMethods`, `items`): [`FulfillmentItemPartition`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentitempartition)[]
**partitionItems_**(`shippingMethods`, `items`): [`FulfillmentItemPartition`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentitempartition)[]
#### Parameters
@@ -520,7 +520,7 @@ ___
### retrieve
▸ **retrieve**(`fulfillmentId`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\>
**retrieve**(`fulfillmentId`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\>
Retrieves a fulfillment by its id.
@@ -573,7 +573,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -611,7 +611,7 @@ ___
### validateFulfillmentLineItem\_
▸ **validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)
**validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)
Checks that a given quantity of a line item can be fulfilled. Fails if the
fulfillable quantity is lower than the requested fulfillment quantity.
@@ -658,7 +658,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx)
**withTransaction**(`transactionManager?`): [`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx
+1 -1
View File
@@ -195,7 +195,7 @@ Standardized error to be used across Medusa project.
### captureStackTrace
▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
Create .stack property on a target object
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx
+130 -130
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx
+9 -9
View File
@@ -137,7 +137,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -162,7 +162,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -239,7 +239,7 @@ ___
### capture
▸ **capture**(`paymentOrId`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\>
**capture**(`paymentOrId`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\>
Captures a payment.
@@ -284,7 +284,7 @@ ___
### create
▸ **create**(`paymentInput`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\>
**create**(`paymentInput`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\>
Created a new payment.
@@ -329,7 +329,7 @@ ___
### refund
▸ **refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\>
**refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\>
refunds a payment.
@@ -398,7 +398,7 @@ ___
### retrieve
▸ **retrieve**(`paymentId`, `config?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\>
**retrieve**(`paymentId`, `config?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\>
Retrieves a payment by id.
@@ -451,7 +451,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -489,7 +489,7 @@ ___
### update
▸ **update**(`paymentId`, `data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\>
**update**(`paymentId`, `data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\>
Updates a payment in order to link it to an order or a swap.
@@ -558,7 +558,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.PaymentService.mdx)
**withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.PaymentService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx
+89 -89
View File
@@ -149,7 +149,7 @@ v0.9.4
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
**[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
#### Returns
@@ -183,7 +183,7 @@ ___
### \_construct
▸ `Optional` **_construct**(`callback`): `void`
`Optional` **_construct**(`callback`): `void`
#### Parameters
@@ -221,7 +221,7 @@ ___
### \_destroy
▸ **_destroy**(`error`, `callback`): `void`
**_destroy**(`error`, `callback`): `void`
#### Parameters
@@ -267,7 +267,7 @@ ___
### \_read
▸ **_read**(`size`): `void`
**_read**(`size`): `void`
#### Parameters
@@ -305,7 +305,7 @@ ___
### addListener
▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
Event emitter
The defined events on documents including:
@@ -357,7 +357,7 @@ The defined events on documents including:
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -399,7 +399,7 @@ The defined events on documents including:
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -441,7 +441,7 @@ The defined events on documents including:
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -483,7 +483,7 @@ The defined events on documents including:
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -525,7 +525,7 @@ The defined events on documents including:
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -567,7 +567,7 @@ The defined events on documents including:
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -609,7 +609,7 @@ The defined events on documents including:
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -655,7 +655,7 @@ ___
### destroy
▸ **destroy**(`error?`): [`Readable`](admin_discounts.internal.Readable.mdx)
**destroy**(`error?`): [`Readable`](admin_discounts.internal.Readable.mdx)
Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable
stream will release any internal resources and subsequent calls to `push()`will be ignored.
@@ -705,7 +705,7 @@ ___
### emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -781,7 +781,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit)
▸ **emit**(`event`, `chunk`): `boolean`
**emit**(`event`, `chunk`): `boolean`
#### Parameters
@@ -823,7 +823,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit)
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -857,7 +857,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit)
▸ **emit**(`event`, `err`): `boolean`
**emit**(`event`, `err`): `boolean`
#### Parameters
@@ -899,7 +899,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit)
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -933,7 +933,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit)
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -967,7 +967,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit)
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -1001,7 +1001,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit)
▸ **emit**(`event`, `...args`): `boolean`
**emit**(`event`, `...args`): `boolean`
#### Parameters
@@ -1047,7 +1047,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -1102,7 +1102,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Readable.mdx#defaultmaxlisteners).
@@ -1134,7 +1134,7 @@ ___
### isPaused
▸ **isPaused**(): `boolean`
**isPaused**(): `boolean`
The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most
typical cases, there will be no reason to
@@ -1177,7 +1177,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -1231,7 +1231,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1283,7 +1283,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**off**(`eventName`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
Alias for `emitter.removeListener()`.
@@ -1335,7 +1335,7 @@ ___
### on
▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -1408,7 +1408,7 @@ v0.1.101
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1450,7 +1450,7 @@ v0.1.101
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1492,7 +1492,7 @@ v0.1.101
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1534,7 +1534,7 @@ v0.1.101
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1576,7 +1576,7 @@ v0.1.101
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1618,7 +1618,7 @@ v0.1.101
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1660,7 +1660,7 @@ v0.1.101
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on)
▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1706,7 +1706,7 @@ ___
### once
▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -1777,7 +1777,7 @@ v0.3.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1819,7 +1819,7 @@ v0.3.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1861,7 +1861,7 @@ v0.3.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1903,7 +1903,7 @@ v0.3.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1945,7 +1945,7 @@ v0.3.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -1987,7 +1987,7 @@ v0.3.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2029,7 +2029,7 @@ v0.3.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once)
▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2075,7 +2075,7 @@ ___
### pause
▸ **pause**(): [`Readable`](admin_discounts.internal.Readable.mdx)
**pause**(): [`Readable`](admin_discounts.internal.Readable.mdx)
The `readable.pause()` method will cause a stream in flowing mode to stop
emitting `'data'` events, switching out of flowing mode. Any data that
@@ -2123,7 +2123,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -2179,7 +2179,7 @@ ___
### prependListener
▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -2238,7 +2238,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2280,7 +2280,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2322,7 +2322,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2364,7 +2364,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2406,7 +2406,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2448,7 +2448,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2490,7 +2490,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependListener](admin_discounts.internal.ReadableBase.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2536,7 +2536,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -2593,7 +2593,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2635,7 +2635,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2677,7 +2677,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2719,7 +2719,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2761,7 +2761,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2803,7 +2803,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2845,7 +2845,7 @@ v6.0.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[prependOnceListener](admin_discounts.internal.ReadableBase.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**prependOnceListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -2891,7 +2891,7 @@ ___
### push
▸ **push**(`chunk`, `encoding?`): `boolean`
**push**(`chunk`, `encoding?`): `boolean`
#### Parameters
@@ -2937,7 +2937,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -3007,7 +3007,7 @@ ___
### read
▸ **read**(`size?`): `any`
**read**(`size?`): `any`
The `readable.read()` method reads data out of the internal buffer and
returns it. If no data is available to be read, `null` is returned. By default,
@@ -3122,7 +3122,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeAllListeners**(`event?`): [`Readable`](admin_discounts.internal.Readable.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -3172,7 +3172,7 @@ ___
### removeListener
▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -3298,7 +3298,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -3340,7 +3340,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -3382,7 +3382,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -3424,7 +3424,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -3466,7 +3466,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -3508,7 +3508,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -3550,7 +3550,7 @@ v0.1.26
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[removeListener](admin_discounts.internal.ReadableBase.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
**removeListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx)
#### Parameters
@@ -3596,7 +3596,7 @@ ___
### resume
▸ **resume**(): [`Readable`](admin_discounts.internal.Readable.mdx)
**resume**(): [`Readable`](admin_discounts.internal.Readable.mdx)
The `readable.resume()` method causes an explicitly paused `Readable` stream to
resume emitting `'data'` events, switching the stream into flowing mode.
@@ -3641,7 +3641,7 @@ ___
### setEncoding
▸ **setEncoding**(`encoding`): [`Readable`](admin_discounts.internal.Readable.mdx)
**setEncoding**(`encoding`): [`Readable`](admin_discounts.internal.Readable.mdx)
The `readable.setEncoding()` method sets the character encoding for
data read from the `Readable` stream.
@@ -3704,7 +3704,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`Readable`](admin_discounts.internal.Readable.mdx)
**setMaxListeners**(`n`): [`Readable`](admin_discounts.internal.Readable.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -3753,7 +3753,7 @@ ___
### unpipe
▸ **unpipe**(`destination?`): [`Readable`](admin_discounts.internal.Readable.mdx)
**unpipe**(`destination?`): [`Readable`](admin_discounts.internal.Readable.mdx)
The `readable.unpipe()` method detaches a `Writable` stream previously attached
using the [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method.
@@ -3818,7 +3818,7 @@ ___
### unshift
▸ **unshift**(`chunk`, `encoding?`): `void`
**unshift**(`chunk`, `encoding?`): `void`
Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the
same as `readable.push(null)`, after which no more data can be written. The EOF
@@ -3928,7 +3928,7 @@ ___
### wrap
▸ **wrap**(`stream`): [`Readable`](admin_discounts.internal.Readable.mdx)
**wrap**(`stream`): [`Readable`](admin_discounts.internal.Readable.mdx)
Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
information.)
@@ -3992,7 +3992,7 @@ ___
### from
▸ `Static` **from**(`iterable`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx)
`Static` **from**(`iterable`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx)
A utility method for creating Readable Streams out of iterators.
@@ -4040,7 +4040,7 @@ ___
### fromWeb
▸ `Static` **fromWeb**(`readableStream`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx)
`Static` **fromWeb**(`readableStream`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx)
A utility method for creating a `Readable` from a web `ReadableStream`.
@@ -4088,7 +4088,7 @@ ___
### getEventListeners
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
`Static` **getEventListeners**(`emitter`, `name`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -4163,7 +4163,7 @@ ___
### isDisturbed
▸ `Static` **isDisturbed**(`stream`): `boolean`
`Static` **isDisturbed**(`stream`): `boolean`
Returns whether the stream has been read from or cancelled.
@@ -4207,7 +4207,7 @@ ___
### listenerCount
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
`Static` **listenerCount**(`emitter`, `eventName`): `number`
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -4273,7 +4273,7 @@ ___
### on
▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
```js
import { on, EventEmitter } from 'node:events';
@@ -4395,7 +4395,7 @@ ___
### once
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
@@ -4544,7 +4544,7 @@ v11.13.0, v10.16.0
[ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once-1)
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
#### Parameters
@@ -4616,7 +4616,7 @@ ___
### setMaxListeners
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
```js
import { setMaxListeners, EventEmitter } from 'node:events';
@@ -4675,7 +4675,7 @@ ___
### toWeb
▸ `Static` **toWeb**(`streamReadable`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\>
`Static` **toWeb**(`streamReadable`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\>
A utility method for creating a web `ReadableStream` from a `Readable`.
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx
+87 -87
View File
@@ -164,7 +164,7 @@ v0.1.26
### [asyncIterator]
▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
**[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
#### Returns
@@ -198,7 +198,7 @@ ___
### \_construct
▸ `Optional` **_construct**(`callback`): `void`
`Optional` **_construct**(`callback`): `void`
#### Parameters
@@ -232,7 +232,7 @@ ___
### \_destroy
▸ **_destroy**(`error`, `callback`): `void`
**_destroy**(`error`, `callback`): `void`
#### Parameters
@@ -274,7 +274,7 @@ ___
### \_read
▸ **_read**(`size`): `void`
**_read**(`size`): `void`
#### Parameters
@@ -308,7 +308,7 @@ ___
### addListener
▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Event emitter
The defined events on documents including:
@@ -364,7 +364,7 @@ The defined events on documents including:
[Stream](admin_discounts.internal.Stream.mdx).[addListener](admin_discounts.internal.Stream.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -410,7 +410,7 @@ NodeJS.ReadableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -456,7 +456,7 @@ NodeJS.ReadableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -502,7 +502,7 @@ NodeJS.ReadableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -548,7 +548,7 @@ NodeJS.ReadableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -594,7 +594,7 @@ NodeJS.ReadableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -640,7 +640,7 @@ NodeJS.ReadableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -690,7 +690,7 @@ ___
### destroy
▸ **destroy**(`error?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**destroy**(`error?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable
stream will release any internal resources and subsequent calls to `push()`will be ignored.
@@ -736,7 +736,7 @@ ___
### emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -816,7 +816,7 @@ v0.1.26
[Stream](admin_discounts.internal.Stream.mdx).[emit](admin_discounts.internal.Stream.mdx#emit)
▸ **emit**(`event`, `chunk`): `boolean`
**emit**(`event`, `chunk`): `boolean`
#### Parameters
@@ -862,7 +862,7 @@ NodeJS.ReadableStream.emit
Stream.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -900,7 +900,7 @@ NodeJS.ReadableStream.emit
Stream.emit
▸ **emit**(`event`, `err`): `boolean`
**emit**(`event`, `err`): `boolean`
#### Parameters
@@ -946,7 +946,7 @@ NodeJS.ReadableStream.emit
Stream.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -984,7 +984,7 @@ NodeJS.ReadableStream.emit
Stream.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -1022,7 +1022,7 @@ NodeJS.ReadableStream.emit
Stream.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -1060,7 +1060,7 @@ NodeJS.ReadableStream.emit
Stream.emit
▸ **emit**(`event`, `...args`): `boolean`
**emit**(`event`, `...args`): `boolean`
#### Parameters
@@ -1110,7 +1110,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -1169,7 +1169,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.ReadableBase.mdx#defaultmaxlisteners).
@@ -1205,7 +1205,7 @@ ___
### isPaused
▸ **isPaused**(): `boolean`
**isPaused**(): `boolean`
The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most
typical cases, there will be no reason to
@@ -1248,7 +1248,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -1306,7 +1306,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1362,7 +1362,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**off**(`eventName`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Alias for `emitter.removeListener()`.
@@ -1418,7 +1418,7 @@ ___
### on
▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -1495,7 +1495,7 @@ v0.1.101
[Stream](admin_discounts.internal.Stream.mdx).[on](admin_discounts.internal.Stream.mdx#on)
▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1541,7 +1541,7 @@ NodeJS.ReadableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1587,7 +1587,7 @@ NodeJS.ReadableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1633,7 +1633,7 @@ NodeJS.ReadableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1679,7 +1679,7 @@ NodeJS.ReadableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1725,7 +1725,7 @@ NodeJS.ReadableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1771,7 +1771,7 @@ NodeJS.ReadableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1821,7 +1821,7 @@ ___
### once
▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -1896,7 +1896,7 @@ v0.3.0
[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once)
▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1942,7 +1942,7 @@ NodeJS.ReadableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -1988,7 +1988,7 @@ NodeJS.ReadableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2034,7 +2034,7 @@ NodeJS.ReadableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2080,7 +2080,7 @@ NodeJS.ReadableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2126,7 +2126,7 @@ NodeJS.ReadableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2172,7 +2172,7 @@ NodeJS.ReadableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2222,7 +2222,7 @@ ___
### pause
▸ **pause**(): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**pause**(): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
The `readable.pause()` method will cause a stream in flowing mode to stop
emitting `'data'` events, switching out of flowing mode. Any data that
@@ -2270,7 +2270,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -2330,7 +2330,7 @@ ___
### prependListener
▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -2393,7 +2393,7 @@ v6.0.0
[Stream](admin_discounts.internal.Stream.mdx).[prependListener](admin_discounts.internal.Stream.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2439,7 +2439,7 @@ NodeJS.ReadableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2485,7 +2485,7 @@ NodeJS.ReadableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2531,7 +2531,7 @@ NodeJS.ReadableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2577,7 +2577,7 @@ NodeJS.ReadableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2623,7 +2623,7 @@ NodeJS.ReadableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2669,7 +2669,7 @@ NodeJS.ReadableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2719,7 +2719,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -2780,7 +2780,7 @@ v6.0.0
[Stream](admin_discounts.internal.Stream.mdx).[prependOnceListener](admin_discounts.internal.Stream.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2826,7 +2826,7 @@ NodeJS.ReadableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2872,7 +2872,7 @@ NodeJS.ReadableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2918,7 +2918,7 @@ NodeJS.ReadableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -2964,7 +2964,7 @@ NodeJS.ReadableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3010,7 +3010,7 @@ NodeJS.ReadableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3056,7 +3056,7 @@ NodeJS.ReadableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3106,7 +3106,7 @@ ___
### push
▸ **push**(`chunk`, `encoding?`): `boolean`
**push**(`chunk`, `encoding?`): `boolean`
#### Parameters
@@ -3148,7 +3148,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -3222,7 +3222,7 @@ ___
### read
▸ **read**(`size?`): `any`
**read**(`size?`): `any`
The `readable.read()` method reads data out of the internal buffer and
returns it. If no data is available to be read, `null` is returned. By default,
@@ -3337,7 +3337,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeAllListeners**(`event?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -3391,7 +3391,7 @@ ___
### removeListener
▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -3521,7 +3521,7 @@ v0.1.26
[Stream](admin_discounts.internal.Stream.mdx).[removeListener](admin_discounts.internal.Stream.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3567,7 +3567,7 @@ NodeJS.ReadableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3613,7 +3613,7 @@ NodeJS.ReadableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3659,7 +3659,7 @@ NodeJS.ReadableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3705,7 +3705,7 @@ NodeJS.ReadableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3751,7 +3751,7 @@ NodeJS.ReadableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3797,7 +3797,7 @@ NodeJS.ReadableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**removeListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
#### Parameters
@@ -3847,7 +3847,7 @@ ___
### resume
▸ **resume**(): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**resume**(): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
The `readable.resume()` method causes an explicitly paused `Readable` stream to
resume emitting `'data'` events, switching the stream into flowing mode.
@@ -3892,7 +3892,7 @@ ___
### setEncoding
▸ **setEncoding**(`encoding`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**setEncoding**(`encoding`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
The `readable.setEncoding()` method sets the character encoding for
data read from the `Readable` stream.
@@ -3955,7 +3955,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**setMaxListeners**(`n`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -4008,7 +4008,7 @@ ___
### unpipe
▸ **unpipe**(`destination?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**unpipe**(`destination?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
The `readable.unpipe()` method detaches a `Writable` stream previously attached
using the [pipe](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx#pipe) method.
@@ -4073,7 +4073,7 @@ ___
### unshift
▸ **unshift**(`chunk`, `encoding?`): `void`
**unshift**(`chunk`, `encoding?`): `void`
Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the
same as `readable.push(null)`, after which no more data can be written. The EOF
@@ -4183,7 +4183,7 @@ ___
### wrap
▸ **wrap**(`stream`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
**wrap**(`stream`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx)
Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
information.)
@@ -4247,7 +4247,7 @@ ___
### from
▸ `Static` **from**(`iterable`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx)
`Static` **from**(`iterable`, `options?`): [`Readable`](admin_discounts.internal.Readable.mdx)
A utility method for creating Readable Streams out of iterators.
@@ -4291,7 +4291,7 @@ ___
### getEventListeners
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
`Static` **getEventListeners**(`emitter`, `name`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -4366,7 +4366,7 @@ ___
### isDisturbed
▸ `Static` **isDisturbed**(`stream`): `boolean`
`Static` **isDisturbed**(`stream`): `boolean`
Returns whether the stream has been read from or cancelled.
@@ -4406,7 +4406,7 @@ ___
### listenerCount
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
`Static` **listenerCount**(`emitter`, `eventName`): `number`
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -4472,7 +4472,7 @@ ___
### on
▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
```js
import { on, EventEmitter } from 'node:events';
@@ -4594,7 +4594,7 @@ ___
### once
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
@@ -4743,7 +4743,7 @@ v11.13.0, v10.16.0
[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once-1)
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
#### Parameters
@@ -4815,7 +4815,7 @@ ___
### setMaxListeners
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
```js
import { setMaxListeners, EventEmitter } from 'node:events';
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx
+127 -127
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx
+22 -22
View File
@@ -64,7 +64,7 @@ v0.1.26
### addListener
▸ **addListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
**addListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
Alias for `emitter.on(eventName, listener)`.
@@ -116,7 +116,7 @@ ___
### emit
▸ **emit**(`eventName`, `...args`): `boolean`
**emit**(`eventName`, `...args`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -204,7 +204,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -259,7 +259,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Stream.mdx#defaultmaxlisteners).
@@ -291,7 +291,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -345,7 +345,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -397,7 +397,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
**off**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
Alias for `emitter.removeListener()`.
@@ -449,7 +449,7 @@ ___
### on
▸ **on**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
**on**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -526,7 +526,7 @@ ___
### once
▸ **once**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
**once**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -601,7 +601,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -657,7 +657,7 @@ ___
### prependListener
▸ **prependListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
**prependListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -720,7 +720,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
**prependOnceListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -781,7 +781,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -851,7 +851,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`Stream`](admin_discounts.internal.Stream.mdx)
**removeAllListeners**(`event?`): [`Stream`](admin_discounts.internal.Stream.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -901,7 +901,7 @@ ___
### removeListener
▸ **removeListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
**removeListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -1031,7 +1031,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`Stream`](admin_discounts.internal.Stream.mdx)
**setMaxListeners**(`n`): [`Stream`](admin_discounts.internal.Stream.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -1080,7 +1080,7 @@ ___
### getEventListeners
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
`Static` **getEventListeners**(`emitter`, `name`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1155,7 +1155,7 @@ ___
### listenerCount
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
`Static` **listenerCount**(`emitter`, `eventName`): `number`
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -1221,7 +1221,7 @@ ___
### on
▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
```js
import { on, EventEmitter } from 'node:events';
@@ -1343,7 +1343,7 @@ ___
### once
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
@@ -1492,7 +1492,7 @@ v11.13.0, v10.16.0
[internal](admin_discounts.internal.internal-5.mdx).[once](admin_discounts.internal.internal-5.mdx#once-1)
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
#### Parameters
@@ -1564,7 +1564,7 @@ ___
### setMaxListeners
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
```js
import { setMaxListeners, EventEmitter } from 'node:events';
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx
+130 -130
View File
File diff suppressed because it is too large. Load diff
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx
+78 -78
View File
@@ -160,7 +160,7 @@ v0.1.26
### \_construct
▸ `Optional` **_construct**(`callback`): `void`
`Optional` **_construct**(`callback`): `void`
#### Parameters
@@ -194,7 +194,7 @@ ___
### \_destroy
▸ **_destroy**(`error`, `callback`): `void`
**_destroy**(`error`, `callback`): `void`
#### Parameters
@@ -236,7 +236,7 @@ ___
### \_final
▸ **_final**(`callback`): `void`
**_final**(`callback`): `void`
#### Parameters
@@ -270,7 +270,7 @@ ___
### \_write
▸ **_write**(`chunk`, `encoding`, `callback`): `void`
**_write**(`chunk`, `encoding`, `callback`): `void`
#### Parameters
@@ -320,7 +320,7 @@ ___
### \_writev
▸ `Optional` **_writev**(`chunks`, `callback`): `void`
`Optional` **_writev**(`chunks`, `callback`): `void`
#### Parameters
@@ -362,7 +362,7 @@ ___
### addListener
▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Event emitter
The defined events on documents including:
@@ -417,7 +417,7 @@ The defined events on documents including:
[Stream](admin_discounts.internal.Stream.mdx).[addListener](admin_discounts.internal.Stream.mdx#addlistener)
▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -463,7 +463,7 @@ NodeJS.WritableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -509,7 +509,7 @@ NodeJS.WritableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -555,7 +555,7 @@ NodeJS.WritableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -601,7 +601,7 @@ NodeJS.WritableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -647,7 +647,7 @@ NodeJS.WritableStream.addListener
Stream.addListener
▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -697,7 +697,7 @@ ___
### cork
▸ **cork**(): `void`
**cork**(): `void`
The `writable.cork()` method forces all written data to be buffered in memory.
The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called.
@@ -734,7 +734,7 @@ ___
### destroy
▸ **destroy**(`error?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**destroy**(`error?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the writable
stream has ended and subsequent calls to `write()` or `end()` will result in
@@ -785,7 +785,7 @@ ___
### emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -865,7 +865,7 @@ v0.1.26
[Stream](admin_discounts.internal.Stream.mdx).[emit](admin_discounts.internal.Stream.mdx#emit)
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -903,7 +903,7 @@ NodeJS.WritableStream.emit
Stream.emit
▸ **emit**(`event`, `err`): `boolean`
**emit**(`event`, `err`): `boolean`
#### Parameters
@@ -949,7 +949,7 @@ NodeJS.WritableStream.emit
Stream.emit
▸ **emit**(`event`): `boolean`
**emit**(`event`): `boolean`
#### Parameters
@@ -987,7 +987,7 @@ NodeJS.WritableStream.emit
Stream.emit
▸ **emit**(`event`, `src`): `boolean`
**emit**(`event`, `src`): `boolean`
#### Parameters
@@ -1033,7 +1033,7 @@ NodeJS.WritableStream.emit
Stream.emit
▸ **emit**(`event`, `src`): `boolean`
**emit**(`event`, `src`): `boolean`
#### Parameters
@@ -1079,7 +1079,7 @@ NodeJS.WritableStream.emit
Stream.emit
▸ **emit**(`event`, `...args`): `boolean`
**emit**(`event`, `...args`): `boolean`
#### Parameters
@@ -1129,7 +1129,7 @@ ___
### end
▸ **end**(`cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**end**(`cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Calling the `writable.end()` method signals that no more data will be written
to the `Writable`. The optional `chunk` and `encoding` arguments allow one
@@ -1183,7 +1183,7 @@ v0.9.4
[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[end](../interfaces/admin_discounts.internal.WritableStream.mdx#end)
▸ **end**(`chunk`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**end**(`chunk`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -1225,7 +1225,7 @@ v0.9.4
[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[end](../interfaces/admin_discounts.internal.WritableStream.mdx#end)
▸ **end**(`chunk`, `encoding`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**end**(`chunk`, `encoding`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -1279,7 +1279,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -1338,7 +1338,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.WritableBase.mdx#defaultmaxlisteners).
@@ -1374,7 +1374,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -1432,7 +1432,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1488,7 +1488,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**off**(`eventName`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Alias for `emitter.removeListener()`.
@@ -1544,7 +1544,7 @@ ___
### on
▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -1621,7 +1621,7 @@ v0.1.101
[Stream](admin_discounts.internal.Stream.mdx).[on](admin_discounts.internal.Stream.mdx#on)
▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -1667,7 +1667,7 @@ NodeJS.WritableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -1713,7 +1713,7 @@ NodeJS.WritableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -1759,7 +1759,7 @@ NodeJS.WritableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -1805,7 +1805,7 @@ NodeJS.WritableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -1851,7 +1851,7 @@ NodeJS.WritableStream.on
Stream.on
▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -1901,7 +1901,7 @@ ___
### once
▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -1976,7 +1976,7 @@ v0.3.0
[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once)
▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2022,7 +2022,7 @@ NodeJS.WritableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2068,7 +2068,7 @@ NodeJS.WritableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2114,7 +2114,7 @@ NodeJS.WritableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2160,7 +2160,7 @@ NodeJS.WritableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2206,7 +2206,7 @@ NodeJS.WritableStream.once
Stream.once
▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2256,7 +2256,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -2312,7 +2312,7 @@ ___
### prependListener
▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -2375,7 +2375,7 @@ v6.0.0
[Stream](admin_discounts.internal.Stream.mdx).[prependListener](admin_discounts.internal.Stream.mdx#prependlistener)
▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2421,7 +2421,7 @@ NodeJS.WritableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2467,7 +2467,7 @@ NodeJS.WritableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2513,7 +2513,7 @@ NodeJS.WritableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2559,7 +2559,7 @@ NodeJS.WritableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2605,7 +2605,7 @@ NodeJS.WritableStream.prependListener
Stream.prependListener
▸ **prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2655,7 +2655,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -2716,7 +2716,7 @@ v6.0.0
[Stream](admin_discounts.internal.Stream.mdx).[prependOnceListener](admin_discounts.internal.Stream.mdx#prependoncelistener)
▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2762,7 +2762,7 @@ NodeJS.WritableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2808,7 +2808,7 @@ NodeJS.WritableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2854,7 +2854,7 @@ NodeJS.WritableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2900,7 +2900,7 @@ NodeJS.WritableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2946,7 +2946,7 @@ NodeJS.WritableStream.prependOnceListener
Stream.prependOnceListener
▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**prependOnceListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -2996,7 +2996,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -3070,7 +3070,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**removeAllListeners**(`event?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -3124,7 +3124,7 @@ ___
### removeListener
▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -3254,7 +3254,7 @@ v0.1.26
[Stream](admin_discounts.internal.Stream.mdx).[removeListener](admin_discounts.internal.Stream.mdx#removelistener)
▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -3300,7 +3300,7 @@ NodeJS.WritableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -3346,7 +3346,7 @@ NodeJS.WritableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -3392,7 +3392,7 @@ NodeJS.WritableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -3438,7 +3438,7 @@ NodeJS.WritableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -3484,7 +3484,7 @@ NodeJS.WritableStream.removeListener
Stream.removeListener
▸ **removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**removeListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
#### Parameters
@@ -3534,7 +3534,7 @@ ___
### setDefaultEncoding
▸ **setDefaultEncoding**(`encoding`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**setDefaultEncoding**(`encoding`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream.
@@ -3574,7 +3574,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
**setMaxListeners**(`n`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -3627,7 +3627,7 @@ ___
### uncork
▸ **uncork**(): `void`
**uncork**(): `void`
The `writable.uncork()` method flushes all data buffered since [cork](admin_discounts.internal.WritableBase.mdx#cork) was called.
@@ -3683,7 +3683,7 @@ ___
### write
▸ **write**(`chunk`, `callback?`): `boolean`
**write**(`chunk`, `callback?`): `boolean`
The `writable.write()` method writes some data to the stream, and calls the
supplied `callback` once the data has been fully handled. If an error
@@ -3778,7 +3778,7 @@ v0.9.4
[WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[write](../interfaces/admin_discounts.internal.WritableStream.mdx#write)
▸ **write**(`chunk`, `encoding`, `callback?`): `boolean`
**write**(`chunk`, `encoding`, `callback?`): `boolean`
#### Parameters
@@ -3832,7 +3832,7 @@ ___
### getEventListeners
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
`Static` **getEventListeners**(`emitter`, `name`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -3907,7 +3907,7 @@ ___
### listenerCount
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
`Static` **listenerCount**(`emitter`, `eventName`): `number`
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -3973,7 +3973,7 @@ ___
### on
▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
```js
import { on, EventEmitter } from 'node:events';
@@ -4095,7 +4095,7 @@ ___
### once
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
@@ -4244,7 +4244,7 @@ v11.13.0, v10.16.0
[Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once-1)
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
#### Parameters
@@ -4316,7 +4316,7 @@ ___
### setMaxListeners
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
```js
import { setMaxListeners, EventEmitter } from 'node:events';
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx
+22 -22
View File
@@ -64,7 +64,7 @@ v0.1.26
### addListener
▸ **addListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
**addListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
Alias for `emitter.on(eventName, listener)`.
@@ -116,7 +116,7 @@ ___
### emit
▸ **emit**(`eventName`, `...args`): `boolean`
**emit**(`eventName`, `...args`): `boolean`
Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
to each.
@@ -204,7 +204,7 @@ ___
### eventNames
▸ **eventNames**(): (`string` \| `symbol`)[]
**eventNames**(): (`string` \| `symbol`)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or `Symbol`s.
@@ -259,7 +259,7 @@ ___
### getMaxListeners
▸ **getMaxListeners**(): `number`
**getMaxListeners**(): `number`
Returns the current max listener value for the `EventEmitter` which is either
set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.internal-5.mdx#defaultmaxlisteners).
@@ -291,7 +291,7 @@ ___
### listenerCount
▸ **listenerCount**(`eventName`, `listener?`): `number`
**listenerCount**(`eventName`, `listener?`): `number`
Returns the number of listeners listening for the event named `eventName`.
If `listener` is provided, it will return how many times the listener is found
@@ -345,7 +345,7 @@ ___
### listeners
▸ **listeners**(`eventName`): `Function`[]
**listeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -397,7 +397,7 @@ ___
### off
▸ **off**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
**off**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
Alias for `emitter.removeListener()`.
@@ -449,7 +449,7 @@ ___
### on
▸ **on**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
**on**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -526,7 +526,7 @@ ___
### once
▸ **once**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
**once**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
Adds a **one-time**`listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.
@@ -601,7 +601,7 @@ ___
### pipe
▸ **pipe**<`T`\>(`destination`, `options?`): `T`
**pipe**<`T`\>(`destination`, `options?`): `T`
<ParameterTypes parameters={[
{
@@ -653,7 +653,7 @@ ___
### prependListener
▸ **prependListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
**prependListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
Adds the `listener` function to the _beginning_ of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
@@ -716,7 +716,7 @@ ___
### prependOnceListener
▸ **prependOnceListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
**prependOnceListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this
listener is removed, and then invoked.
@@ -777,7 +777,7 @@ ___
### rawListeners
▸ **rawListeners**(`eventName`): `Function`[]
**rawListeners**(`eventName`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`,
including any wrappers (such as those created by `.once()`).
@@ -847,7 +847,7 @@ ___
### removeAllListeners
▸ **removeAllListeners**(`event?`): [`internal`](admin_discounts.internal.internal-5.mdx)
**removeAllListeners**(`event?`): [`internal`](admin_discounts.internal.internal-5.mdx)
Removes all listeners, or those of the specified `eventName`.
@@ -897,7 +897,7 @@ ___
### removeListener
▸ **removeListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
**removeListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx)
Removes the specified `listener` from the listener array for the event named`eventName`.
@@ -1027,7 +1027,7 @@ ___
### setMaxListeners
▸ **setMaxListeners**(`n`): [`internal`](admin_discounts.internal.internal-5.mdx)
**setMaxListeners**(`n`): [`internal`](admin_discounts.internal.internal-5.mdx)
By default `EventEmitter`s will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
@@ -1076,7 +1076,7 @@ ___
### getEventListeners
▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[]
`Static` **getEventListeners**(`emitter`, `name`): `Function`[]
Returns a copy of the array of listeners for the event named `eventName`.
@@ -1151,7 +1151,7 @@ ___
### listenerCount
▸ `Static` **listenerCount**(`emitter`, `eventName`): `number`
`Static` **listenerCount**(`emitter`, `eventName`): `number`
A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`.
@@ -1217,7 +1217,7 @@ ___
### on
▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\>
```js
import { on, EventEmitter } from 'node:events';
@@ -1339,7 +1339,7 @@ ___
### once
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given
event or that is rejected if the `EventEmitter` emits `'error'` while waiting.
@@ -1488,7 +1488,7 @@ v11.13.0, v10.16.0
[EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[once](admin_discounts.internal.EventEmitter-1.mdx#once-1)
▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\>
#### Parameters
@@ -1560,7 +1560,7 @@ ___
### setMaxListeners
▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void`
```js
import { setMaxListeners, EventEmitter } from 'node:events';
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx
+10 -10
View File
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -114,7 +114,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -195,7 +195,7 @@ ___
### buildTemplate
▸ `Abstract` **buildTemplate**(): `Promise`<`string`\>
`Abstract` **buildTemplate**(): `Promise`<`string`\>
Builds and returns a template file that can be downloaded and filled in
@@ -231,7 +231,7 @@ ___
### handleProcessingError
▸ `Protected` **handleProcessingError**<`T`\>(`batchJobId`, `err`, `result`): `Promise`<`void`\>
`Protected` **handleProcessingError**<`T`\>(`batchJobId`, `err`, `result`): `Promise`<`void`\>
<ParameterTypes parameters={[
{
@@ -292,7 +292,7 @@ ___
### preProcessBatchJob
▸ **preProcessBatchJob**(`batchJobId`): `Promise`<`void`\>
**preProcessBatchJob**(`batchJobId`): `Promise`<`void`\>
Method for pre-processing a batch job
@@ -332,7 +332,7 @@ ___
### prepareBatchJobForProcessing
▸ **prepareBatchJobForProcessing**(`batchJob`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\>
**prepareBatchJobForProcessing**(`batchJob`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\>
Method for preparing a batch job for processing
@@ -389,7 +389,7 @@ ___
### processJob
▸ `Abstract` **processJob**(`batchJobId`): `Promise`<`void`\>
`Abstract` **processJob**(`batchJobId`): `Promise`<`void`\>
Method does the actual processing of the job. Should report back on the progress of the operation.
@@ -429,7 +429,7 @@ ___
### shouldRetryOnProcessingError
▸ `Protected` **shouldRetryOnProcessingError**(`batchJob`, `err`): `Promise`<`boolean`\>
`Protected` **shouldRetryOnProcessingError**(`batchJob`, `err`): `Promise`<`boolean`\>
#### Parameters
@@ -480,7 +480,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -522,7 +522,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx)
**withTransaction**(`transactionManager?`): [`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx
+5 -5
View File
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -163,7 +163,7 @@ ___
### complete
▸ `Abstract` **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\>
`Abstract` **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\>
Takes a cart id and completes the cart. This for example takes place when
creating an order or confirming a swap.
@@ -229,7 +229,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -267,7 +267,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`AbstractCartCompletionStrategy`](admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx)
**withTransaction**(`transactionManager?`): [`AbstractCartCompletionStrategy`](admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx
+10 -10
View File
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -171,7 +171,7 @@ ___
### delete
▸ `Abstract` **delete**(`fileData`): `Promise`<`void`\>
`Abstract` **delete**(`fileData`): `Promise`<`void`\>
remove file from fileservice
@@ -211,7 +211,7 @@ ___
### getDownloadStream
▸ `Abstract` **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx)\>
`Abstract` **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx)\>
download file from fileservice as stream
@@ -260,7 +260,7 @@ ___
### getPresignedDownloadUrl
▸ `Abstract` **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\>
`Abstract` **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\>
Generate a presigned download url to obtain a file
@@ -309,7 +309,7 @@ ___
### getUploadStreamDescriptor
▸ `Abstract` **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\>
`Abstract` **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\>
upload file to fileservice from stream
@@ -358,7 +358,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -400,7 +400,7 @@ ___
### upload
▸ `Abstract` **upload**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\>
`Abstract` **upload**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\>
upload file to fileservice
@@ -449,7 +449,7 @@ ___
### uploadProtected
▸ `Abstract` **uploadProtected**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\>
`Abstract` **uploadProtected**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\>
upload private file to fileservice
@@ -498,7 +498,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`AbstractFileService`](admin_discounts.internal.internal.AbstractFileService.mdx)
**withTransaction**(`transactionManager?`): [`AbstractFileService`](admin_discounts.internal.internal.AbstractFileService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx
+13 -13
View File
@@ -48,7 +48,7 @@ Fullfillment provider plugin services should extend the AbstractFulfillmentServi
### calculatePrice
▸ `Abstract` **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\>
`Abstract` **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\>
Used to calculate a price for a given shipping option.
@@ -113,7 +113,7 @@ ___
### canCalculate
▸ `Abstract` **canCalculate**(`data`): `Promise`<`boolean`\>
`Abstract` **canCalculate**(`data`): `Promise`<`boolean`\>
Used to determine if a shipping option can have a calculated price
@@ -162,7 +162,7 @@ ___
### cancelFulfillment
▸ `Abstract` **cancelFulfillment**(`fulfillment`): `Promise`<`any`\>
`Abstract` **cancelFulfillment**(`fulfillment`): `Promise`<`any`\>
Cancel a fulfillment using data from the fulfillment
@@ -211,7 +211,7 @@ ___
### createFulfillment
▸ `Abstract` **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\>
`Abstract` **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\>
Create a fulfillment using data from shipping method, line items, and fulfillment. All from the order.
The returned value of this method will populate the `fulfillment.data` field.
@@ -285,7 +285,7 @@ ___
### createReturn
▸ `Abstract` **createReturn**(`returnOrder`): `Promise`<Record<`string`, `unknown`\>\>
`Abstract` **createReturn**(`returnOrder`): `Promise`<Record<`string`, `unknown`\>\>
Used to create a return order. Should return the data necessary for future
operations on the return; in particular the data may be used to receive
@@ -353,7 +353,7 @@ ___
### getFulfillmentDocuments
▸ `Abstract` **getFulfillmentDocuments**(`data`): `Promise`<`any`\>
`Abstract` **getFulfillmentDocuments**(`data`): `Promise`<`any`\>
Used to retrieve documents associated with a fulfillment.
@@ -402,7 +402,7 @@ ___
### getFulfillmentOptions
▸ `Abstract` **getFulfillmentOptions**(): `Promise`<`any`[]\>
`Abstract` **getFulfillmentOptions**(): `Promise`<`any`[]\>
Called before a shipping option is created in Admin. The method should
return all of the options that the fulfillment provider can be used with,
@@ -452,7 +452,7 @@ ___
### getIdentifier
▸ **getIdentifier**(): `string`
**getIdentifier**(): `string`
Return a unique identifier to retrieve the fulfillment plugin provider
@@ -479,7 +479,7 @@ ___
### getReturnDocuments
▸ `Abstract` **getReturnDocuments**(`data`): `Promise`<`any`\>
`Abstract` **getReturnDocuments**(`data`): `Promise`<`any`\>
Used to retrieve documents related to a return order.
@@ -528,7 +528,7 @@ ___
### getShipmentDocuments
▸ `Abstract` **getShipmentDocuments**(`data`): `Promise`<`any`\>
`Abstract` **getShipmentDocuments**(`data`): `Promise`<`any`\>
Used to retrieve documents related to a shipment.
@@ -577,7 +577,7 @@ ___
### retrieveDocuments
▸ `Abstract` **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\>
`Abstract` **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\>
#### Parameters
@@ -632,7 +632,7 @@ ___
### validateFulfillmentData
▸ `Abstract` **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`<Record<`string`, `unknown`\>\>
`Abstract` **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`<Record<`string`, `unknown`\>\>
Called before a shipping method is set on a cart to ensure that the data
sent with the shipping method is valid. The data object may contain extra
@@ -718,7 +718,7 @@ ___
### validateOption
▸ `Abstract` **validateOption**(`data`): `Promise`<`boolean`\>
`Abstract` **validateOption**(`data`): `Promise`<`boolean`\>
Called before a shipping option is created in Admin. Use this to ensure
that a fulfillment option does in fact exist.
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx
+7 -7
View File
@@ -69,7 +69,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -98,7 +98,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -179,7 +179,7 @@ ___
### getIdentifier
▸ **getIdentifier**(): `string`
**getIdentifier**(): `string`
#### Returns
@@ -200,7 +200,7 @@ ___
### resendNotification
▸ `Abstract` **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\>
`Abstract` **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\>
#### Parameters
@@ -263,7 +263,7 @@ ___
### sendNotification
▸ `Abstract` **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\>
`Abstract` **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\>
#### Parameters
@@ -326,7 +326,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -368,7 +368,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx)
**withTransaction**(`transactionManager?`): [`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx
+11 -11
View File
@@ -47,7 +47,7 @@ Payment processor in charge of creating , managing and processing a payment
### authorizePayment
▸ `Abstract` **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\>
`Abstract` **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\>
Authorize an existing session if it is not already authorized
@@ -104,7 +104,7 @@ ___
### cancelPayment
▸ `Abstract` **cancelPayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
`Abstract` **cancelPayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Cancel an existing session
@@ -153,7 +153,7 @@ ___
### capturePayment
▸ `Abstract` **capturePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
`Abstract` **capturePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Capture an existing session
@@ -202,7 +202,7 @@ ___
### deletePayment
▸ `Abstract` **deletePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
`Abstract` **deletePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Delete an existing session
@@ -251,7 +251,7 @@ ___
### getIdentifier
▸ **getIdentifier**(): `string`
**getIdentifier**(): `string`
Return a unique identifier to retrieve the payment plugin provider
@@ -278,7 +278,7 @@ ___
### getPaymentStatus
▸ `Abstract` **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\>
`Abstract` **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\>
Return the status of the session
@@ -359,7 +359,7 @@ ___
### initiatePayment
▸ `Abstract` **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\>
`Abstract` **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\>
Initiate a payment session with the external provider
@@ -408,7 +408,7 @@ ___
### refundPayment
▸ `Abstract` **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
`Abstract` **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Refund an existing session
@@ -465,7 +465,7 @@ ___
### retrievePayment
▸ `Abstract` **retrievePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
`Abstract` **retrievePayment**(`paymentSessionData`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Retrieve an existing session
@@ -514,7 +514,7 @@ ___
### updatePayment
▸ `Abstract` **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\>
`Abstract` **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\>
Update an existing payment session
@@ -563,7 +563,7 @@ ___
### updatePaymentData
▸ `Abstract` **updatePaymentData**(`sessionId`, `data`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
`Abstract` **updatePaymentData**(`sessionId`, `data`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\>
Update the session data for a payment session
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx
+19 -19
View File
@@ -75,7 +75,7 @@ in the near future use the AbstractPaymentProcessor instead
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -104,7 +104,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -185,7 +185,7 @@ ___
### authorizePayment
▸ `Abstract` **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\>
`Abstract` **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\>
#### Parameters
@@ -242,7 +242,7 @@ ___
### cancelPayment
▸ `Abstract` **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
`Abstract` **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -295,7 +295,7 @@ ___
### capturePayment
▸ `Abstract` **capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
`Abstract` **capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -348,7 +348,7 @@ ___
### createPayment
▸ `Abstract` **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\>
`Abstract` **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\>
#### Parameters
@@ -391,7 +391,7 @@ ___
[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[createPayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#createpayment)
▸ `Abstract` **createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
`Abstract` **createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -444,7 +444,7 @@ ___
### deletePayment
▸ `Abstract` **deletePayment**(`paymentSession`): `Promise`<`void`\>
`Abstract` **deletePayment**(`paymentSession`): `Promise`<`void`\>
This will be
@@ -488,7 +488,7 @@ ___
### getIdentifier
▸ **getIdentifier**(): `string`
**getIdentifier**(): `string`
#### Returns
@@ -513,7 +513,7 @@ ___
### getPaymentData
▸ `Abstract` **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
`Abstract` **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
#### Parameters
@@ -562,7 +562,7 @@ ___
### getStatus
▸ `Abstract` **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\>
`Abstract` **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\>
This will be
@@ -647,7 +647,7 @@ ___
### refundPayment
▸ `Abstract` **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
`Abstract` **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -708,7 +708,7 @@ ___
### retrievePayment
▸ `Abstract` **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
`Abstract` **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
#### Parameters
@@ -757,7 +757,7 @@ ___
### retrieveSavedMethods
▸ **retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\>
**retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\>
This will be
@@ -819,7 +819,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -861,7 +861,7 @@ ___
### updatePayment
▸ `Abstract` **updatePayment**(`paymentSessionData`, `context`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\>
`Abstract` **updatePayment**(`paymentSessionData`, `context`): `Promise`<Record<`string`, `unknown`\> \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\>
#### Parameters
@@ -912,7 +912,7 @@ ___
[PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[updatePayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#updatepayment)
▸ `Abstract` **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
`Abstract` **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
This will be
@@ -973,7 +973,7 @@ ___
### updatePaymentData
▸ `Abstract` **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
`Abstract` **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\>
#### Parameters
@@ -1030,7 +1030,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx)
**withTransaction**(`transactionManager?`): [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx
+6 -6
View File
@@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -163,7 +163,7 @@ ___
### calculateVariantPrice
▸ `Abstract` **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\>
`Abstract` **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\>
Calculate the original and discount price for a given variant in a set of
circumstances described in the context.
@@ -238,7 +238,7 @@ ___
### onVariantsPricesUpdate
▸ **onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\>
**onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\>
Notify price selection strategy that variants prices have been updated.
@@ -278,7 +278,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -316,7 +316,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`AbstractPriceSelectionStrategy`](admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx)
**withTransaction**(`transactionManager?`): [`AbstractPriceSelectionStrategy`](admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx
+2 -2
View File
@@ -33,7 +33,7 @@ items and shipping methods.
### getIdentifier
▸ **getIdentifier**(): `string`
**getIdentifier**(): `string`
#### Returns
@@ -54,7 +54,7 @@ ___
### getTaxLines
▸ `Abstract` **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\>
`Abstract` **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\>
Retrieves the numerical tax lines for a calculation context.
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx
+8 -8
View File
@@ -73,7 +73,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -98,7 +98,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -175,7 +175,7 @@ ___
### create
▸ **create**(`userId`, `data`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\>
**create**(`userId`, `data`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\>
Creates an analytics config.
@@ -228,7 +228,7 @@ ___
### delete
▸ **delete**(`userId`): `Promise`<`void`\>
**delete**(`userId`): `Promise`<`void`\>
Deletes an analytics config.
@@ -264,7 +264,7 @@ ___
### retrieve
▸ **retrieve**(`userId`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\>
**retrieve**(`userId`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\>
#### Parameters
@@ -307,7 +307,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -345,7 +345,7 @@ ___
### update
▸ **update**(`userId`, `update`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\>
**update**(`userId`, `update`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\>
Updates an analytics config. If the config does not exist, it will be created instead.
@@ -398,7 +398,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`AnalyticsConfigService`](admin_discounts.internal.internal.AnalyticsConfigService.mdx)
**withTransaction**(`transactionManager?`): [`AnalyticsConfigService`](admin_discounts.internal.internal.AnalyticsConfigService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx
+8 -8
View File
@@ -75,7 +75,7 @@ Can authenticate a user based on email password combination
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -100,7 +100,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -177,7 +177,7 @@ ___
### authenticate
▸ **authenticate**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\>
**authenticate**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\>
Authenticates a given user based on an email, password combination. Uses
scrypt to match password with hashed value.
@@ -231,7 +231,7 @@ ___
### authenticateAPIToken
▸ **authenticateAPIToken**(`token`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\>
**authenticateAPIToken**(`token`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\>
Authenticates a given user with an API token
@@ -276,7 +276,7 @@ ___
### authenticateCustomer
▸ **authenticateCustomer**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\>
**authenticateCustomer**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\>
Authenticates a customer based on an email, password combination. Uses
scrypt to match password with hashed value.
@@ -330,7 +330,7 @@ ___
### comparePassword\_
▸ `Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\>
`Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\>
Verifies if a password is valid given the provided password hash
@@ -383,7 +383,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -421,7 +421,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`AuthService`](admin_discounts.internal.internal.AuthService.mdx)
**withTransaction**(`transactionManager?`): [`AuthService`](admin_discounts.internal.internal.AuthService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx
+16 -16
View File
@@ -161,7 +161,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -186,7 +186,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -263,7 +263,7 @@ ___
### cancel
▸ **cancel**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**cancel**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -306,7 +306,7 @@ ___
### complete
▸ **complete**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**complete**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -349,7 +349,7 @@ ___
### confirm
▸ **confirm**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**confirm**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -392,7 +392,7 @@ ___
### create
▸ **create**(`data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**create**(`data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -435,7 +435,7 @@ ___
### listAndCount
▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)[], `number`]\>
**listAndCount**(`selector?`, `config?`): `Promise`<[[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)[], `number`]\>
#### Parameters
@@ -494,7 +494,7 @@ ___
### prepareBatchJobForProcessing
▸ **prepareBatchJobForProcessing**(`data`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\>
**prepareBatchJobForProcessing**(`data`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\>
#### Parameters
@@ -545,7 +545,7 @@ ___
### retrieve
▸ **retrieve**(`batchJobId`, `config?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**retrieve**(`batchJobId`, `config?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -596,7 +596,7 @@ ___
### setFailed
▸ **setFailed**(`batchJobOrId`, `error?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**setFailed**(`batchJobOrId`, `error?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -647,7 +647,7 @@ ___
### setPreProcessingDone
▸ **setPreProcessingDone**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**setPreProcessingDone**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -690,7 +690,7 @@ ___
### setProcessing
▸ **setProcessing**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**setProcessing**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -733,7 +733,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -771,7 +771,7 @@ ___
### update
▸ **update**(`batchJobOrId`, `data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
**update**(`batchJobOrId`, `data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -822,7 +822,7 @@ ___
### updateStatus
▸ `Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
`Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\>
#### Parameters
@@ -873,7 +873,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`BatchJobService`](admin_discounts.internal.internal.BatchJobService.mdx)
**withTransaction**(`transactionManager?`): [`BatchJobService`](admin_discounts.internal.internal.BatchJobService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx
+45 -45
View File
@@ -313,7 +313,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -338,7 +338,7 @@ TransactionBaseService.activeManager\_
### addLineItem
▸ **addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`void`\>
**addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`void`\>
Adds a line item to the cart.
@@ -402,7 +402,7 @@ ___
### addOrUpdateLineItems
▸ **addOrUpdateLineItems**(`cartId`, `lineItems`, `config?`): `Promise`<`void`\>
**addOrUpdateLineItems**(`cartId`, `lineItems`, `config?`): `Promise`<`void`\>
Adds or update one or multiple line items to the cart. It also update all existing items in the cart
to have has_shipping to false. Finally, the adjustments will be updated.
@@ -463,7 +463,7 @@ ___
### addShippingMethod
▸ **addShippingMethod**(`cartOrId`, `optionId`, `data?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**addShippingMethod**(`cartOrId`, `optionId`, `data?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
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
@@ -528,7 +528,7 @@ ___
### adjustFreeShipping\_
▸ `Protected` **adjustFreeShipping_**(`cart`, `shouldAdd`): `Promise`<`void`\>
`Protected` **adjustFreeShipping_**(`cart`, `shouldAdd`): `Promise`<`void`\>
Ensures shipping total on cart is correct in regards to a potential free
shipping discount
@@ -575,7 +575,7 @@ ___
### applyDiscount
▸ **applyDiscount**(`cart`, `discountCode`): `Promise`<`void`\>
**applyDiscount**(`cart`, `discountCode`): `Promise`<`void`\>
Updates the cart's discounts.
If discount besides free shipping is already applied, this
@@ -622,7 +622,7 @@ ___
### applyDiscounts
▸ **applyDiscounts**(`cart`, `discountCodes`): `Promise`<`void`\>
**applyDiscounts**(`cart`, `discountCodes`): `Promise`<`void`\>
Updates the cart's discounts.
If discount besides free shipping is already applied, this
@@ -669,7 +669,7 @@ ___
### applyGiftCard\_
▸ `Protected` **applyGiftCard_**(`cart`, `code`): `Promise`<`void`\>
`Protected` **applyGiftCard_**(`cart`, `code`): `Promise`<`void`\>
#### Parameters
@@ -711,7 +711,7 @@ ___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -788,7 +788,7 @@ ___
### authorizePayment
▸ **authorizePayment**(`cartId`, `context?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**authorizePayment**(`cartId`, `context?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Authorizes a payment for a cart.
Will authorize with chosen payment provider. This will return
@@ -845,7 +845,7 @@ ___
### create
▸ **create**(`data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**create**(`data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Creates a cart.
@@ -890,7 +890,7 @@ ___
### createOrFetchGuestCustomerFromEmail\_
▸ `Protected` **createOrFetchGuestCustomerFromEmail_**(`email`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\>
`Protected` **createOrFetchGuestCustomerFromEmail_**(`email`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\>
Creates or fetches a user based on an email.
@@ -935,7 +935,7 @@ ___
### createTaxLines
▸ **createTaxLines**(`cartOrId`): `Promise`<`void`\>
**createTaxLines**(`cartOrId`): `Promise`<`void`\>
#### Parameters
@@ -969,7 +969,7 @@ ___
### decorateTotals
▸ **decorateTotals**(`cart`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\>
**decorateTotals**(`cart`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\>
#### Parameters
@@ -1037,7 +1037,7 @@ ___
### decorateTotals\_
▸ `Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
`Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
#### Parameters
@@ -1100,7 +1100,7 @@ ___
### delete
▸ **delete**(`cartId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**delete**(`cartId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Deletes a cart from the database. Completed carts cannot be deleted.
@@ -1145,7 +1145,7 @@ ___
### deletePaymentSession
▸ **deletePaymentSession**(`cartId`, `providerId`): `Promise`<`void`\>
**deletePaymentSession**(`cartId`, `providerId`): `Promise`<`void`\>
Removes a payment session from the cart.
@@ -1189,7 +1189,7 @@ ___
### deleteTaxLines
▸ **deleteTaxLines**(`id`): `Promise`<`void`\>
**deleteTaxLines**(`id`): `Promise`<`void`\>
#### Parameters
@@ -1223,7 +1223,7 @@ ___
### findCustomShippingOption
▸ **findCustomShippingOption**(`cartCustomShippingOptions`, `optionId`): `undefined` \| [`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)
**findCustomShippingOption**(`cartCustomShippingOptions`, `optionId`): `undefined` \| [`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)
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
@@ -1268,7 +1268,7 @@ ___
### getValidatedSalesChannel
▸ `Protected` **getValidatedSalesChannel**(`salesChannelId?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\>
`Protected` **getValidatedSalesChannel**(`salesChannelId?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\>
#### Parameters
@@ -1311,7 +1311,7 @@ ___
### list
▸ **list**(`selector`, `config?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)[]\>
**list**(`selector`, `config?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)[]\>
#### Parameters
@@ -1371,7 +1371,7 @@ ___
### onSalesChannelChange
▸ `Protected` **onSalesChannelChange**(`cart`, `newSalesChannelId`): `Promise`<`void`\>
`Protected` **onSalesChannelChange**(`cart`, `newSalesChannelId`): `Promise`<`void`\>
Remove the cart line item that does not belongs to the newly assigned sales channel
@@ -1415,7 +1415,7 @@ ___
### refreshAdjustments\_
▸ `Protected` **refreshAdjustments_**(`cart`): `Promise`<`void`\>
`Protected` **refreshAdjustments_**(`cart`): `Promise`<`void`\>
#### Parameters
@@ -1449,7 +1449,7 @@ ___
### refreshPaymentSession
▸ **refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\>
**refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\>
Refreshes a payment session on a cart
@@ -1493,7 +1493,7 @@ ___
### removeDiscount
▸ **removeDiscount**(`cartId`, `discountCode`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**removeDiscount**(`cartId`, `discountCode`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Removes a discount based on a discount code.
@@ -1546,7 +1546,7 @@ ___
### removeLineItem
▸ **removeLineItem**(`cartId`, `lineItemId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**removeLineItem**(`cartId`, `lineItemId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Removes a line item from the cart.
@@ -1599,7 +1599,7 @@ ___
### retrieve
▸ **retrieve**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**retrieve**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Gets a cart by id.
@@ -1660,7 +1660,7 @@ ___
### retrieveLegacy
▸ `Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
`Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
#### Parameters
@@ -1721,7 +1721,7 @@ ___
### retrieveWithTotals
▸ **retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\>
**retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\>
#### Parameters
@@ -1797,7 +1797,7 @@ ___
### setMetadata
▸ **setMetadata**(`cartId`, `key`, `value`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**setMetadata**(`cartId`, `key`, `value`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Dedicated method to set metadata for a cart.
To ensure that plugins does not overwrite each
@@ -1860,7 +1860,7 @@ ___
### setPaymentSession
▸ **setPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\>
**setPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\>
Selects a payment session for a cart and creates a payment object in the external provider system
@@ -1904,7 +1904,7 @@ ___
### setPaymentSessions
▸ **setPaymentSessions**(`cartOrCartId`): `Promise`<`void`\>
**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
@@ -1944,7 +1944,7 @@ ___
### setRegion\_
▸ `Protected` **setRegion_**(`cart`, `regionId`, `countryCode`): `Promise`<`void`\>
`Protected` **setRegion_**(`cart`, `regionId`, `countryCode`): `Promise`<`void`\>
Set's the region of a cart.
@@ -1996,7 +1996,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -2034,7 +2034,7 @@ ___
### transformQueryForTotals\_
▸ `Protected` **transformQueryForTotals_**(`config`): [`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Cart`](admin_collections.internal.Cart.mdx)\> & { `totalsToSelect`: [`TotalField`](../modules/admin_discounts.internal.internal.mdx#totalfield)[] }
`Protected` **transformQueryForTotals_**(`config`): [`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Cart`](admin_collections.internal.Cart.mdx)\> & { `totalsToSelect`: [`TotalField`](../modules/admin_discounts.internal.internal.mdx#totalfield)[] }
#### Parameters
@@ -2068,7 +2068,7 @@ ___
### update
▸ **update**(`cartOrId`, `data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**update**(`cartOrId`, `data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
#### Parameters
@@ -2119,7 +2119,7 @@ ___
### updateBillingAddress\_
▸ `Protected` **updateBillingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\>
`Protected` **updateBillingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\>
Updates the cart's billing address.
@@ -2171,7 +2171,7 @@ ___
### updateCustomerId\_
▸ `Protected` **updateCustomerId_**(`cart`, `customerId`): `Promise`<`void`\>
`Protected` **updateCustomerId_**(`cart`, `customerId`): `Promise`<`void`\>
Sets the customer id of a cart
@@ -2215,7 +2215,7 @@ ___
### updateLineItem
▸ **updateLineItem**(`cartId`, `lineItemId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**updateLineItem**(`cartId`, `lineItemId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Updates a cart's existing line item.
@@ -2276,7 +2276,7 @@ ___
### updatePaymentSession
▸ **updatePaymentSession**(`cartId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
**updatePaymentSession**(`cartId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\>
Updates the currently selected payment session.
@@ -2329,7 +2329,7 @@ ___
### updateShippingAddress\_
▸ `Protected` **updateShippingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\>
`Protected` **updateShippingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\>
Updates the cart's shipping address.
@@ -2381,7 +2381,7 @@ ___
### updateUnitPrices\_
▸ `Protected` **updateUnitPrices_**(`cart`, `regionId?`, `customer_id?`): `Promise`<`void`\>
`Protected` **updateUnitPrices_**(`cart`, `regionId?`, `customer_id?`): `Promise`<`void`\>
#### Parameters
@@ -2431,7 +2431,7 @@ ___
### validateLineItem
▸ `Protected` **validateLineItem**(`sales_channel_id`, `lineItem`): `Promise`<`boolean`\>
`Protected` **validateLineItem**(`sales_channel_id`, `lineItem`): `Promise`<`boolean`\>
Check if line item's variant belongs to the cart's sales channel.
@@ -2492,7 +2492,7 @@ ___
### validateLineItemShipping\_
▸ `Protected` **validateLineItemShipping_**(`shippingMethods`, `lineItemShippingProfiledId`): `boolean`
`Protected` **validateLineItemShipping_**(`shippingMethods`, `lineItemShippingProfiledId`): `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
@@ -2538,7 +2538,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`CartService`](admin_discounts.internal.internal.CartService.mdx)
**withTransaction**(`transactionManager?`): [`CartService`](admin_discounts.internal.internal.CartService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx
+8 -8
View File
@@ -129,7 +129,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -154,7 +154,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -231,7 +231,7 @@ ___
### create
▸ **create**(`data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\>
**create**(`data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\>
#### Parameters
@@ -274,7 +274,7 @@ ___
### list
▸ **list**(`selector`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)[]\>
**list**(`selector`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)[]\>
#### Parameters
@@ -334,7 +334,7 @@ ___
### retrieve
▸ **retrieve**(`claimItemId`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\>
**retrieve**(`claimItemId`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\>
Gets a claim item by id.
@@ -387,7 +387,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -425,7 +425,7 @@ ___
### update
▸ **update**(`id`, `data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\>
**update**(`id`, `data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\>
#### Parameters
@@ -476,7 +476,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`ClaimItemService`](admin_discounts.internal.internal.ClaimItemService.mdx)
**withTransaction**(`transactionManager?`): [`ClaimItemService`](admin_discounts.internal.internal.ClaimItemService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx
+15 -15
View File
@@ -241,7 +241,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -266,7 +266,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -343,7 +343,7 @@ ___
### cancel
▸ **cancel**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
**cancel**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
#### Parameters
@@ -386,7 +386,7 @@ ___
### cancelFulfillment
▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
**cancelFulfillment**(`fulfillmentId`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
#### Parameters
@@ -429,7 +429,7 @@ ___
### create
▸ **create**(`data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
**create**(`data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
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
@@ -476,7 +476,7 @@ ___
### createFulfillment
▸ **createFulfillment**(`id`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
**createFulfillment**(`id`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
#### Parameters
@@ -551,7 +551,7 @@ ___
### createShipment
▸ **createShipment**(`id`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
**createShipment**(`id`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
#### Parameters
@@ -634,7 +634,7 @@ ___
### getRefundTotalForClaimLinesOnOrder
▸ `Protected` **getRefundTotalForClaimLinesOnOrder**(`order`, `claimItems`): `Promise`<`number`\>
`Protected` **getRefundTotalForClaimLinesOnOrder**(`order`, `claimItems`): `Promise`<`number`\>
Finds claim line items on an order and calculates the refund amount.
There are three places too look:
@@ -692,7 +692,7 @@ ___
### list
▸ **list**(`selector`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)[]\>
**list**(`selector`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)[]\>
#### Parameters
@@ -752,7 +752,7 @@ ___
### processRefund
▸ **processRefund**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
**processRefund**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
#### Parameters
@@ -795,7 +795,7 @@ ___
### retrieve
▸ **retrieve**(`claimId`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
**retrieve**(`claimId`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
Gets an order by id.
@@ -848,7 +848,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -886,7 +886,7 @@ ___
### update
▸ **update**(`id`, `data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
**update**(`id`, `data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\>
#### Parameters
@@ -937,7 +937,7 @@ ___
### validateCreateClaimInput
▸ `Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\>
`Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\>
#### Parameters
@@ -971,7 +971,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`ClaimService`](admin_discounts.internal.internal.ClaimService.mdx)
**withTransaction**(`transactionManager?`): [`ClaimService`](admin_discounts.internal.internal.ClaimService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx
+7 -7
View File
@@ -97,7 +97,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -122,7 +122,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -199,7 +199,7 @@ ___
### listAndCount
▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Currency`](admin_collections.internal.Currency.mdx)[], `number`]\>
**listAndCount**(`selector`, `config?`): `Promise`<[[`Currency`](admin_collections.internal.Currency.mdx)[], `number`]\>
Lists currencies based on the provided parameters and includes the count of
currencies that match the query.
@@ -261,7 +261,7 @@ ___
### retrieveByCode
▸ **retrieveByCode**(`code`): `Promise`<[`Currency`](admin_collections.internal.Currency.mdx)\>
**retrieveByCode**(`code`): `Promise`<[`Currency`](admin_collections.internal.Currency.mdx)\>
Return the currency
@@ -306,7 +306,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -344,7 +344,7 @@ ___
### update
▸ **update**(`code`, `data`): `Promise`<`undefined` \| [`Currency`](admin_collections.internal.Currency.mdx)\>
**update**(`code`, `data`): `Promise`<`undefined` \| [`Currency`](admin_collections.internal.Currency.mdx)\>
Update a currency
@@ -397,7 +397,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`CurrencyService`](admin_discounts.internal.internal.CurrencyService.mdx)
**withTransaction**(`transactionManager?`): [`CurrencyService`](admin_discounts.internal.internal.CurrencyService.mdx)
#### Parameters
www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx
+7 -7
View File
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
@@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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
@@ -167,7 +167,7 @@ ___
### create
▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\>
**create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\>
Creates a custom shipping option
@@ -222,7 +222,7 @@ ___
### list
▸ **list**(`selector`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)[]\>
**list**(`selector`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)[]\>
Fetches all custom shipping options based on the given selector
@@ -284,7 +284,7 @@ ___
### retrieve
▸ **retrieve**(`id`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)\>
**retrieve**(`id`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)\>
Retrieves a specific shipping option.
@@ -337,7 +337,7 @@ ___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
@@ -375,7 +375,7 @@ ___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx)
**withTransaction**(`transactionManager?`): [`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx)
#### Parameters
Loaded 100 of 540 files, more files were not shown because too many files have changed in this diff. Show more