chore(docs): Generated References (#5516)
Generated the following references: - `js-client` - `pricing` - `services` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
80fe362f33
commit
aa2bb7a31b
@@ -35,6 +35,14 @@ export interface CreatePriceSetMoneyAmountDTO {
|
||||
money_amount?: MoneyAmountDTO | string
|
||||
}
|
||||
|
||||
/**
|
||||
* @interface
|
||||
*
|
||||
* Filters to apply on price set money amounts.
|
||||
*
|
||||
* @prop id - The IDs to filter the price set money amounts by.
|
||||
* @prop price_set_id - The IDs to filter the price set money amount's associated price set.
|
||||
*/
|
||||
export interface FilterablePriceSetMoneyAmountProps
|
||||
extends BaseFilterable<FilterablePriceSetMoneyAmountProps> {
|
||||
id?: string[]
|
||||
|
||||
@@ -2200,13 +2200,215 @@ export interface IPricingModuleService {
|
||||
sharedContext?: Context
|
||||
): Promise<[PriceSetMoneyAmountRulesDTO[], number]>
|
||||
|
||||
|
||||
/**
|
||||
* This method is used to retrieve a paginated list of price set money amounts based on optional filters and configuration.
|
||||
*
|
||||
* @param {FilterablePriceSetMoneyAmountProps} filters - The filters to apply on the retrieved price set money amounts.
|
||||
* @param {FindConfig<PriceSetMoneyAmountDTO>} config -
|
||||
* The configurations determining how the price set money amounts are retrieved. Its properties, such as `select` or `relations`, accept the
|
||||
* attributes or relations associated with a price set money amount.
|
||||
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
||||
* @returns {Promise<PriceSetMoneyAmountDTO[]>} The list of price set money amounts.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* To retrieve a list of price set money amounts using their IDs:
|
||||
*
|
||||
* ```ts
|
||||
* import {
|
||||
* initialize as initializePricingModule,
|
||||
* } from "@medusajs/pricing"
|
||||
*
|
||||
* async function retrievePriceSetMoneyAmounts (id: string) {
|
||||
* const pricingService = await initializePricingModule()
|
||||
*
|
||||
* const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({
|
||||
* id: [id]
|
||||
* })
|
||||
*
|
||||
* // do something with the price set money amounts or return them
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* To specify relations that should be retrieved within the price set money amounts:
|
||||
*
|
||||
* ```ts
|
||||
* import {
|
||||
* initialize as initializePricingModule,
|
||||
* } from "@medusajs/pricing"
|
||||
*
|
||||
* async function retrievePriceSetMoneyAmounts (id: string) {
|
||||
* const pricingService = await initializePricingModule()
|
||||
*
|
||||
* const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({
|
||||
* id: [id]
|
||||
* }, {
|
||||
* relations: ["price_rules"]
|
||||
* })
|
||||
*
|
||||
* // do something with the price set money amounts or return them
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
*
|
||||
* ```ts
|
||||
* import {
|
||||
* initialize as initializePricingModule,
|
||||
* } from "@medusajs/pricing"
|
||||
*
|
||||
* async function retrievePriceSetMoneyAmounts (id: string, skip: number, take: number) {
|
||||
* const pricingService = await initializePricingModule()
|
||||
*
|
||||
* const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({
|
||||
* id: [id]
|
||||
* }, {
|
||||
* relations: ["price_rules"],
|
||||
* skip,
|
||||
* take
|
||||
* })
|
||||
*
|
||||
* // do something with the price set money amounts or return them
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example:
|
||||
*
|
||||
* ```ts
|
||||
* import {
|
||||
* initialize as initializePricingModule,
|
||||
* } from "@medusajs/pricing"
|
||||
*
|
||||
* async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], skip: number, take: number) {
|
||||
* const pricingService = await initializePricingModule()
|
||||
*
|
||||
* const priceSetMoneyAmounts = await pricingService.listPriceSetMoneyAmounts({
|
||||
* $and: [
|
||||
* {
|
||||
* id: ids
|
||||
* },
|
||||
* {
|
||||
* title: titles
|
||||
* }
|
||||
* ]
|
||||
* }, {
|
||||
* relations: ["price_rules"],
|
||||
* skip,
|
||||
* take
|
||||
* })
|
||||
*
|
||||
* // do something with the price set money amounts or return them
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
listPriceSetMoneyAmounts(
|
||||
filters?: FilterablePriceSetMoneyAmountProps,
|
||||
config?: FindConfig<PriceSetMoneyAmountDTO>,
|
||||
sharedContext?: Context
|
||||
): Promise<PriceSetMoneyAmountDTO[]>
|
||||
|
||||
/**
|
||||
* This method is used to retrieve a paginated list of price set money amounts along with the total count of
|
||||
* available price set money amounts satisfying the provided filters.
|
||||
*
|
||||
* @param {FilterablePriceSetMoneyAmountProps} filters - The filters to apply on the retrieved price set money amounts.
|
||||
* @param {FindConfig<PriceSetMoneyAmountDTO>} config -
|
||||
* The configurations determining how the price set money amounts are retrieved. Its properties, such as `select` or `relations`, accept the
|
||||
* attributes or relations associated with a price set money amount.
|
||||
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
||||
* @returns {Promise<[PriceSetMoneyAmountDTO[], number]>} The list of price set money amounts and their total count.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* To retrieve a list of price set money amounts using their IDs:
|
||||
*
|
||||
* ```ts
|
||||
* import {
|
||||
* initialize as initializePricingModule,
|
||||
* } from "@medusajs/pricing"
|
||||
*
|
||||
* async function retrievePriceSetMoneyAmounts (id: string) {
|
||||
* const pricingService = await initializePricingModule()
|
||||
*
|
||||
* const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({
|
||||
* id: [id]
|
||||
* })
|
||||
*
|
||||
* // do something with the price set money amounts or return them
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* To specify relations that should be retrieved within the price set money amounts:
|
||||
*
|
||||
* ```ts
|
||||
* import {
|
||||
* initialize as initializePricingModule,
|
||||
* } from "@medusajs/pricing"
|
||||
*
|
||||
* async function retrievePriceSetMoneyAmounts (id: string) {
|
||||
* const pricingService = await initializePricingModule()
|
||||
*
|
||||
* const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({
|
||||
* id: [id]
|
||||
* }, {
|
||||
* relations: ["price_rules"],
|
||||
* })
|
||||
*
|
||||
* // do something with the price set money amounts or return them
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
|
||||
*
|
||||
* ```ts
|
||||
* import {
|
||||
* initialize as initializePricingModule,
|
||||
* } from "@medusajs/pricing"
|
||||
*
|
||||
* async function retrievePriceSetMoneyAmounts (id: string, skip: number, take: number) {
|
||||
* const pricingService = await initializePricingModule()
|
||||
*
|
||||
* const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({
|
||||
* id: [id]
|
||||
* }, {
|
||||
* relations: ["price_rules"],
|
||||
* skip,
|
||||
* take
|
||||
* })
|
||||
*
|
||||
* // do something with the price set money amounts or return them
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* You can also use the `$and` or `$or` properties of the `filter` parameter to use and/or conditions in your filters. For example:
|
||||
*
|
||||
* ```ts
|
||||
* import {
|
||||
* initialize as initializePricingModule,
|
||||
* } from "@medusajs/pricing"
|
||||
*
|
||||
* async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], skip: number, take: number) {
|
||||
* const pricingService = await initializePricingModule()
|
||||
*
|
||||
* const [priceSetMoneyAmounts, count] = await pricingService.listAndCountPriceSetMoneyAmounts({
|
||||
* $and: [
|
||||
* {
|
||||
* id: ids
|
||||
* },
|
||||
* {
|
||||
* title: titles
|
||||
* }
|
||||
* ]
|
||||
* }, {
|
||||
* relations: ["price_rules"],
|
||||
* skip,
|
||||
* take
|
||||
* })
|
||||
*
|
||||
* // do something with the price set money amounts or return them
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
listAndCountPriceSetMoneyAmounts(
|
||||
filters?: FilterablePriceSetMoneyAmountProps,
|
||||
config?: FindConfig<PriceSetMoneyAmountDTO>,
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateCartWorkflowInputDTO
|
||||
|
||||
[WorkflowTypes](../../internal-1/modules/admin_discounts.internal.internal-1.WorkflowTypes.mdx).[CartWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.CartWorkflow.mdx).CreateCartWorkflowInputDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "billing_address",
|
||||
"type": "[`AddressDTO`](../../internal/modules/admin_discounts.internal.internal-1.mdx#addressdto)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "billing_address_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customer_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "email",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[`CreateLineItemInputDTO`](admin_discounts.internal.internal-1.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx)[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "region_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sales_channel_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "[`AddressDTO`](../../internal/modules/admin_discounts.internal.internal-1.mdx#addressdto)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "shipping_address_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateLineItemInputDTO
|
||||
|
||||
[WorkflowTypes](../../internal-1/modules/admin_discounts.internal.internal-1.WorkflowTypes.mdx).[CartWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.CartWorkflow.mdx).CreateLineItemInputDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "variant_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AddressCreatePayload
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).AddressCreatePayload
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "address_1",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_2",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "city",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "company",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "first_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "last_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "phone",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "postal_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "province",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AddressPayload
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).AddressPayload
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "address_1",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_2",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "city",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "company",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "first_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "last_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "phone",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "postal_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "province",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# BaseEntity
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).BaseEntity
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,75 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CustomFindOptions
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).CustomFindOptions
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TModel",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "InKeys",
|
||||
"type": "keyof `TModel`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "order",
|
||||
"type": "`OrderByCondition`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "select",
|
||||
"type": "`FindOptionsSelect`<`TModel`\\> \\| `FindOptionsSelectByString`<`TModel`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "skip",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "take",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "where",
|
||||
"type": "`FindOptionsWhere`<`TModel`\\> & { [P in string \\| number \\| symbol]?: TModel[P][] } \\| `FindOptionsWhere`<`TModel`\\>[] & { [P in string \\| number \\| symbol]?: TModel[P][] }",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DateComparisonOperator
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).DateComparisonOperator
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "gt",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "gte",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "lt",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "lte",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# EmptyQueryParams
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).EmptyQueryParams
|
||||
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FindConfig
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).FindConfig
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).FindConfig
|
||||
|
||||
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
|
||||
which provides correct typing of field names in its properties.
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FindPaginationParams
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).FindPaginationParams
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "limit",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "offset",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FindParams
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).FindParams
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "expand",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "fields",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# NumericalComparisonOperator
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).NumericalComparisonOperator
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).NumericalComparisonOperator
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# RepositoryTransformOptions
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).RepositoryTransformOptions
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SoftDeletableEntity
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).SoftDeletableEntity
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# StringComparisonOperator
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).StringComparisonOperator
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[CommonTypes](../../internal-1/modules/admin_discounts.internal.internal-1.CommonTypes.mdx).StringComparisonOperator
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# WorkflowInputConfig
|
||||
|
||||
[WorkflowTypes](../../internal-1/modules/admin_discounts.internal.internal-1.WorkflowTypes.mdx).[CommonWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.CommonWorkflow.mdx).WorkflowInputConfig
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "listConfig",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "listConfig.relations",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "listConfig.select",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "retrieveConfig",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "retrieveConfig.relations",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "retrieveConfig.select",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# BaseFilterable
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[DAL](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx).BaseFilterable
|
||||
|
||||
An object used to allow specifying flexible queries with and/or conditions.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`BaseFilterable`](admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<`T`\\> \\| `T`)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`BaseFilterable`](admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<`T`\\> \\| `T`)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,91 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# OptionsQuery
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[DAL](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx).OptionsQuery
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "P",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "fields",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "filters",
|
||||
"type": "`boolean` \\| `string`[] \\| [`Dictionary`](../../admin_discounts/modules/admin_discounts.internal.mdx#dictionary)<`boolean` \\| [`Dictionary`](../../admin_discounts/modules/admin_discounts.internal.mdx#dictionary)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "groupBy",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "offset",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "orderBy",
|
||||
"type": "[`Order`](../../admin_discounts/modules/admin_discounts.internal.mdx#order)<`T`\\> \\| [`Order`](../../admin_discounts/modules/admin_discounts.internal.mdx#order)<`T`\\>[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "populate",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,601 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# RepositoryService
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[DAL](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx).RepositoryService
|
||||
|
||||
Data access layer (DAL) interface to implements for any repository service.
|
||||
This layer helps to separate the business logic (service layer) from accessing the
|
||||
ORM directly and allows to switch to another ORM without changing the business logic.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Methods
|
||||
|
||||
### create
|
||||
|
||||
**create**(`data`, `context?`): `Promise`<`T`[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`T`[]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
**delete**(`ids`, `context?`): `Promise`<`void`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ids",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### find
|
||||
|
||||
**find**(`options?`, `context?`): `Promise`<`T`[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx#findoptions)<`T`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`T`[]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### findAndCount
|
||||
|
||||
**findAndCount**(`options?`, `context?`): `Promise`<[`T`[], `number`]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx#findoptions)<`T`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`T`[], `number`]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], `number`]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "number",
|
||||
"type": "`number`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### getActiveManager
|
||||
|
||||
**getActiveManager**<`TManager`\>(): `TManager`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`TManager`
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseRepositoryService](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx).[getActiveManager](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx#getactivemanager)
|
||||
|
||||
___
|
||||
|
||||
### getFreshManager
|
||||
|
||||
**getFreshManager**<`TManager`\>(): `TManager`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`TManager`
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseRepositoryService](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx).[getFreshManager](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx#getfreshmanager)
|
||||
|
||||
___
|
||||
|
||||
### restore
|
||||
|
||||
**restore**(`ids`, `context?`): `Promise`<[`T`[], Record<`string`, `unknown`[]\>]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ids",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`T`[], Record<`string`, `unknown`[]\>]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], Record<`string`, `unknown`[]\\>]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "Record",
|
||||
"type": "Record<`string`, `unknown`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### serialize
|
||||
|
||||
**serialize**<`TOutput`\>(`data`, `options?`): `Promise`<`TOutput`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TOutput",
|
||||
"type": "`object` \\| `object`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TOutput`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TOutput`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseRepositoryService](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx).[serialize](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx#serialize)
|
||||
|
||||
___
|
||||
|
||||
### softDelete
|
||||
|
||||
**softDelete**(`ids`, `context?`): `Promise`<[`T`[], Record<`string`, `unknown`[]\>]\>
|
||||
|
||||
Soft delete entities and cascade to related entities if configured.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ids",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`T`[], Record<`string`, `unknown`[]\>]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], Record<`string`, `unknown`[]\\>]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "[T[], Record<string, string[]>] the second value being the map of the entity names and ids that were soft deleted",
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "Record",
|
||||
"type": "Record<`string`, `unknown`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### transaction
|
||||
|
||||
**transaction**<`TManager`\>(`task`, `context?`): `Promise`<`any`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "task",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.transaction",
|
||||
"type": "`TManager`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`any`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "any",
|
||||
"type": "`any`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseRepositoryService](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx).[transaction](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx#transaction)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
**update**(`data`, `context?`): `Promise`<`T`[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`T`[]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# RestoreReturn
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[DAL](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx).RestoreReturn
|
||||
|
||||
An object that is used to specify an entity's related entities that should be restored when the main entity is restored.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TReturnableLinkableKeys",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "returnLinkableKeys",
|
||||
"type": "`TReturnableLinkableKeys`[]",
|
||||
"description": "An array of strings, each being the ID attribute names of the entity's relations.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# SoftDeleteReturn
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[DAL](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx).SoftDeleteReturn
|
||||
|
||||
An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TReturnableLinkableKeys",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "returnLinkableKeys",
|
||||
"type": "`TReturnableLinkableKeys`[]",
|
||||
"description": "An array of strings, each being the ID attribute names of the entity's relations.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,437 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# TreeRepositoryService
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[DAL](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx).TreeRepositoryService
|
||||
|
||||
Data access layer (DAL) interface to implements for any repository service.
|
||||
This layer helps to separate the business logic (service layer) from accessing the
|
||||
ORM directly and allows to switch to another ORM without changing the business logic.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "T",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Methods
|
||||
|
||||
### create
|
||||
|
||||
**create**(`data`, `context?`): `Promise`<`T`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`unknown`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`T`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
**delete**(`id`, `context?`): `Promise`<`void`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### find
|
||||
|
||||
**find**(`options?`, `transformOptions?`, `context?`): `Promise`<`T`[]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx#findoptions)<`T`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transformOptions",
|
||||
"type": "[`RepositoryTransformOptions`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`T`[]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### findAndCount
|
||||
|
||||
**findAndCount**(`options?`, `transformOptions?`, `context?`): `Promise`<[`T`[], `number`]\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../../internal-1/modules/admin_discounts.internal.internal-1.DAL.mdx#findoptions)<`T`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transformOptions",
|
||||
"type": "[`RepositoryTransformOptions`](../../CommonTypes/interfaces/admin_discounts.internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/admin_discounts.internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`T`[], `number`]\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], `number`]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "number",
|
||||
"type": "`number`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### getActiveManager
|
||||
|
||||
**getActiveManager**<`TManager`\>(): `TManager`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`TManager`
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseRepositoryService](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx).[getActiveManager](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx#getactivemanager)
|
||||
|
||||
___
|
||||
|
||||
### getFreshManager
|
||||
|
||||
**getFreshManager**<`TManager`\>(): `TManager`
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`TManager`
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseRepositoryService](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx).[getFreshManager](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx#getfreshmanager)
|
||||
|
||||
___
|
||||
|
||||
### serialize
|
||||
|
||||
**serialize**<`TOutput`\>(`data`, `options?`): `Promise`<`TOutput`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TOutput",
|
||||
"type": "`object` \\| `object`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TOutput`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TOutput`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseRepositoryService](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx).[serialize](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx#serialize)
|
||||
|
||||
___
|
||||
|
||||
### transaction
|
||||
|
||||
**transaction**<`TManager`\>(`task`, `context?`): `Promise`<`any`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "TManager",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "task",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.transaction",
|
||||
"type": "`TManager`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`any`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "any",
|
||||
"type": "`any`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[BaseRepositoryService](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx).[transaction](../../internal/interfaces/admin_discounts.internal.BaseRepositoryService.mdx#transaction)
|
||||
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# IFlagRouter
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).IFlagRouter
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[FeatureFlagTypes](../../internal-1/modules/admin_discounts.internal.internal-1.FeatureFlagTypes.mdx).IFlagRouter
|
||||
|
||||
## Implemented by
|
||||
|
||||
- [`FlagRouter`](../classes/admin_discounts.internal.FlagRouter.mdx)
|
||||
- [`FlagRouter`](../../internal/classes/admin_discounts.internal.FlagRouter.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
},
|
||||
{
|
||||
"name": "listFlags",
|
||||
"type": "() => [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1)",
|
||||
"type": "() => [`FeatureFlagsResponse`](../../internal-1/modules/admin_discounts.internal.internal-1.FeatureFlagTypes.mdx#featureflagsresponse)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
@@ -0,0 +1,118 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateInventoryItemInputDTO
|
||||
|
||||
[WorkflowTypes](../../internal-1/modules/admin_discounts.internal.internal-1.WorkflowTypes.mdx).[InventoryWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.InventoryWorkflow.mdx).CreateInventoryItemInputDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "thumbnail",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateInventoryItemsWorkflowInputDTO
|
||||
|
||||
[WorkflowTypes](../../internal-1/modules/admin_discounts.internal.internal-1.WorkflowTypes.mdx).[InventoryWorkflow](../../WorkflowTypes/modules/admin_discounts.internal.internal-1.WorkflowTypes.InventoryWorkflow.mdx).CreateInventoryItemsWorkflowInputDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "inventoryItems",
|
||||
"type": "[`CreateInventoryItemInputDTO`](admin_discounts.internal.internal-1.WorkflowTypes.InventoryWorkflow.CreateInventoryItemInputDTO.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# MODULE\_RESOURCE\_TYPE
|
||||
|
||||
[admin/discounts](../../modules/admin_discounts.mdx).[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).MODULE_RESOURCE_TYPE
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ModulesSdkTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx).MODULE_RESOURCE_TYPE
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# MODULE\_SCOPE
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ModulesSdkTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx).MODULE_SCOPE
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### EXTERNAL
|
||||
|
||||
**EXTERNAL** = ``"external"``
|
||||
|
||||
___
|
||||
|
||||
### INTERNAL
|
||||
|
||||
**INTERNAL** = ``"internal"``
|
||||
@@ -0,0 +1,110 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ModuleServiceInitializeOptions
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ModulesSdkTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ModulesSdkTypes.mdx).ModuleServiceInitializeOptions
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "database",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.clientUrl",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.connection",
|
||||
"type": "`any`",
|
||||
"description": "Forces to use a shared knex connection",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.database",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.debug",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.driverOptions",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.host",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.password",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.pool",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.port",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.schema",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.user",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AddPricesDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).AddPricesDTO
|
||||
|
||||
The prices to add to a price set.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "priceSetId",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set to add prices to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "prices",
|
||||
"type": "[`CreatePricesDTO`](admin_discounts.internal.internal-1.PricingTypes.CreatePricesDTO.mdx)[]",
|
||||
"description": "The prices to add to the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AddRulesDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).AddRulesDTO
|
||||
|
||||
The rules to add to a price set.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "priceSetId",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set to add the rules to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "{ `attribute`: `string` }[]",
|
||||
"description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CalculatedPriceSetDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CalculatedPriceSetDTO
|
||||
|
||||
A calculated price set's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The currency code of the calculated price. It can possibly be `null`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateCurrencyDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreateCurrencyDTO
|
||||
|
||||
A currency to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol_native",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateMoneyAmountDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreateMoneyAmountDTO
|
||||
|
||||
The money amount to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CreateCurrencyDTO`](admin_discounts.internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)",
|
||||
"description": "The currency of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreatePriceRuleDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreatePriceRuleDTO
|
||||
|
||||
A price rule to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreatePriceSetDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreatePriceSetDTO
|
||||
|
||||
A price set to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prices",
|
||||
"type": "[`CreatePricesDTO`](admin_discounts.internal.internal-1.PricingTypes.CreatePricesDTO.mdx)[]",
|
||||
"description": "The prices to create and add to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "{ `rule_attribute`: `string` }[]",
|
||||
"description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreatePriceSetMoneyAmountDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreatePriceSetMoneyAmountDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "money_amount",
|
||||
"type": "`string` \\| [`MoneyAmountDTO`](admin_discounts.internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "`string` \\| [`PriceSetDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreatePriceSetMoneyAmountRulesDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreatePriceSetMoneyAmountRulesDTO
|
||||
|
||||
The price set money amount rule to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "`string`",
|
||||
"description": "The ID of a price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "`string`",
|
||||
"description": "The ID of a rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price set money amount rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreatePriceSetRuleTypeDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreatePriceSetRuleTypeDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](admin_discounts.internal.internal-1.PricingTypes.RuleTypeDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreatePricesDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreatePricesDTO
|
||||
|
||||
The prices to create part of a price set.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CreateCurrencyDTO`](admin_discounts.internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)",
|
||||
"description": "The currency of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "Record<`string`, `string`\\>",
|
||||
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateRuleTypeDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CreateRuleTypeDTO
|
||||
|
||||
The rule type to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "default_priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_attribute",
|
||||
"type": "`string`",
|
||||
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CurrencyDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).CurrencyDTO
|
||||
|
||||
A currency's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol_native",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableCurrencyProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).FilterableCurrencyProps
|
||||
|
||||
Filters to apply on a currency.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableCurrencyProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableCurrencyProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableCurrencyProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableCurrencyProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`[]",
|
||||
"description": "The codes to filter the currencies by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableMoneyAmountProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).FilterableMoneyAmountProps
|
||||
|
||||
Filters to apply on a money amount.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "Currency codes to filter money amounts by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "IDs to filter money amounts by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterablePriceRuleProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).FilterablePriceRuleProps
|
||||
|
||||
Filters to apply to price rules.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterablePriceRuleProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceRuleProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterablePriceRuleProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceRuleProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs to filter price rules by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`[]",
|
||||
"description": "The names to filter price rules by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs to filter the price rule's associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs to filter the price rule's associated rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterablePriceSetMoneyAmountProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).FilterablePriceSetMoneyAmountProps
|
||||
|
||||
An object used to allow specifying flexible queries with and/or conditions.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterablePriceSetMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterablePriceSetMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterablePriceSetMoneyAmountRulesProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).FilterablePriceSetMoneyAmountRulesProps
|
||||
|
||||
Filters to apply on price set money amount rules.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "The ID to filter price set money amount rules by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount_id",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs to filter the price set money amount rule's associated price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs to filter the price set money amount rule's associated rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`[]",
|
||||
"description": "The value to filter price set money amount rules by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterablePriceSetProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).FilterablePriceSetProps
|
||||
|
||||
Filters to apply on price sets.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterablePriceSetProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterablePriceSetProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "IDs to filter price sets by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`FilterableMoneyAmountProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx)",
|
||||
"description": "Filters to apply on a price set's associated money amounts.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterablePriceSetRuleTypeProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).FilterablePriceSetRuleTypeProps
|
||||
|
||||
An object used to allow specifying flexible queries with and/or conditions.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterablePriceSetRuleTypeProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetRuleTypeProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterablePriceSetRuleTypeProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetRuleTypeProps`](admin_discounts.internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableRuleTypeProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).FilterableRuleTypeProps
|
||||
|
||||
Filters to apply on rule types.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableRuleTypeProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableRuleTypeProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableRuleTypeProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableRuleTypeProps`](admin_discounts.internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs to filter rule types by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`[]",
|
||||
"description": "The names to filter rule types by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_attribute",
|
||||
"type": "`string`[]",
|
||||
"description": "The rule attributes to filter rule types by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# MoneyAmountDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).MoneyAmountDTO
|
||||
|
||||
A money amount's data. A money amount represents a price.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](admin_discounts.internal.internal-1.PricingTypes.CurrencyDTO.mdx)",
|
||||
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,88 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceRuleDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).PriceRuleDTO
|
||||
|
||||
A price rule's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](admin_discounts.internal.internal-1.PricingTypes.RuleTypeDTO.mdx)",
|
||||
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceSetDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).PriceSetDTO
|
||||
|
||||
A price set's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](admin_discounts.internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](admin_discounts.internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceSetMoneyAmountDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).PriceSetMoneyAmountDTO
|
||||
|
||||
A price set money amount's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of a price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amount",
|
||||
"type": "[`MoneyAmountDTO`](admin_discounts.internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)",
|
||||
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_rules",
|
||||
"type": "[`PriceRuleDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title of the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceSetMoneyAmountRulesDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).PriceSetMoneyAmountRulesDTO
|
||||
|
||||
A price set money amount rule's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "[`PriceSetMoneyAmountDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceSetMoneyAmountDTO.mdx)",
|
||||
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](admin_discounts.internal.internal-1.PricingTypes.RuleTypeDTO.mdx)",
|
||||
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price set money amount rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceSetRuleTypeDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).PriceSetRuleTypeDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](admin_discounts.internal.internal-1.PricingTypes.RuleTypeDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PricingContext
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).PricingContext
|
||||
|
||||
The context to calculate prices. For example, you can specify the currency code to calculate prices in.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "context",
|
||||
"type": "Record<`string`, `string` \\| `number`\\>",
|
||||
"description": "an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in. Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PricingFilters
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).PricingFilters
|
||||
|
||||
Filters to apply on prices.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "IDs to filter prices.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# RemovePriceSetRulesDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).RemovePriceSetRulesDTO
|
||||
|
||||
The rules to remove from a price set.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "`string`[]",
|
||||
"description": "The rules to remove. Each string is the `rule_attribute` of a rule to remove.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# RuleTypeDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).RuleTypeDTO
|
||||
|
||||
A rule type's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "default_priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_attribute",
|
||||
"type": "`string`",
|
||||
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdateCurrencyDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).UpdateCurrencyDTO
|
||||
|
||||
The data to update in a currency. The `code` is used to identify which currency to update.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol_native",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdateMoneyAmountDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).UpdateMoneyAmountDTO
|
||||
|
||||
*
|
||||
|
||||
The data to update in a money amount. The `id` is used to identify which money amount to update.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency to associate with the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdatePriceRuleDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).UpdatePriceRuleDTO
|
||||
|
||||
The data to update in a price rule. The `id` is used to identify which money amount to update.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price rule to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price rule.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdatePriceSetDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).UpdatePriceSetDTO
|
||||
|
||||
The data to update in a price set. The `id` is used to identify which price set to update.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the ID of the price set to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdatePriceSetMoneyAmountDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).UpdatePriceSetMoneyAmountDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amount",
|
||||
"type": "[`MoneyAmountDTO`](admin_discounts.internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdatePriceSetMoneyAmountRulesDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).UpdatePriceSetMoneyAmountRulesDTO
|
||||
|
||||
The data to update in a price set money amount rule. The `id` is used to identify which money amount to update.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set money amount rule to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "`string`",
|
||||
"description": "The ID of a price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "`string`",
|
||||
"description": "The ID of a rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price set money amount rule.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdatePriceSetRuleTypeDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).UpdatePriceSetRuleTypeDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdateRuleTypeDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[PricingTypes](../../internal-1/modules/admin_discounts.internal.internal-1.PricingTypes.mdx).UpdateRuleTypeDTO
|
||||
|
||||
The data to update in a rule type. The `id` is used to identify which price set to update.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "default_priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_attribute",
|
||||
"type": "`string`",
|
||||
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductStatus
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductStatus
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### DRAFT
|
||||
|
||||
**DRAFT** = ``"draft"``
|
||||
|
||||
___
|
||||
|
||||
### PROPOSED
|
||||
|
||||
**PROPOSED** = ``"proposed"``
|
||||
|
||||
___
|
||||
|
||||
### PUBLISHED
|
||||
|
||||
**PUBLISHED** = ``"published"``
|
||||
|
||||
___
|
||||
|
||||
### REJECTED
|
||||
|
||||
**REJECTED** = ``"rejected"``
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductCategoryDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductCategoryDTO
|
||||
|
||||
A product category to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string`",
|
||||
"description": "The product category's handle.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_active",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product category is active.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_internal",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The product category's name.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "parent_category_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The ID of the parent product category, if it has any. It may also be `null`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rank",
|
||||
"type": "`number`",
|
||||
"description": "The ranking of the category among sibling categories.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductCollectionDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductCollectionDTO
|
||||
|
||||
A product collection to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string`",
|
||||
"description": "The product collection's handle. If not provided, the value of this attribute is set to the slug version of the title.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "product_ids",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The product collection's title.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,216 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductDTO
|
||||
|
||||
A product to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "categories",
|
||||
"type": "{ `id`: `string` }[]",
|
||||
"description": "The product categories to associate with the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "collection_id",
|
||||
"type": "`string`",
|
||||
"description": "The product collection to be associated with the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "The description of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "discountable",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product can be discounted.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string`",
|
||||
"description": "The handle of the product. The handle can be used to create slug URL paths. If not supplied, the value of the `handle` attribute of the product is set to the slug version of the `title` attribute.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`number`",
|
||||
"description": "The height of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`string`",
|
||||
"description": "The HS Code of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "images",
|
||||
"type": "`string`[] \\| { `id?`: `string` ; `url`: `string` }[]",
|
||||
"description": "The product's images. If an array of strings is supplied, each string will be a URL and a `ProductImage` will be created and associated with the product. If an array of objects is supplied, you can pass along the ID of an existing `ProductImage`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_giftcard",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product is a gift card.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`number`",
|
||||
"description": "The length of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`string`",
|
||||
"description": "The material of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`string`",
|
||||
"description": "The MID Code of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`CreateProductOptionDTO`](admin_discounts.internal.internal-1.ProductTypes.CreateProductOptionDTO.mdx)[]",
|
||||
"description": "The product options to be created and associated with the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`string`",
|
||||
"description": "The origin country of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[`ProductStatus`](../enums/admin_discounts.internal.internal-1.ProductTypes.ProductStatus.mdx)",
|
||||
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/admin_discounts.internal.internal-1.ProductTypes.ProductStatus.mdx).",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "subtitle",
|
||||
"type": "`string`",
|
||||
"description": "The subttle of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "tags",
|
||||
"type": "[`CreateProductTagDTO`](admin_discounts.internal.internal-1.ProductTypes.CreateProductTagDTO.mdx)[]",
|
||||
"description": "The product tags to be created and associated with the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "thumbnail",
|
||||
"type": "`string`",
|
||||
"description": "The URL of the product's thumbnail.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title of the product.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "[`CreateProductTypeDTO`](admin_discounts.internal.internal-1.ProductTypes.CreateProductTypeDTO.mdx)",
|
||||
"description": "The product type to create and associate with the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type_id",
|
||||
"type": "`string`",
|
||||
"description": "The product type to be associated with the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "variants",
|
||||
"type": "[`CreateProductVariantDTO`](admin_discounts.internal.internal-1.ProductTypes.CreateProductVariantDTO.mdx)[]",
|
||||
"description": "The product variants to be created and associated with the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`number`",
|
||||
"description": "The weight of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`number`",
|
||||
"description": "The width of the product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,190 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductOnlyDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductOnlyDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "categories",
|
||||
"type": "{ `id`: `string` }[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "collection_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "discountable",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "images",
|
||||
"type": "{ `id?`: `string` ; `url`: `string` }[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_giftcard",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[`ProductStatus`](../enums/admin_discounts.internal.internal-1.ProductTypes.ProductStatus.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "subtitle",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "tags",
|
||||
"type": "{ `id`: `string` }[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "thumbnail",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductOptionDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductOptionDTO
|
||||
|
||||
A product option to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "product_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated product.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The product option's title.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductOptionOnlyDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductOptionOnlyDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "product",
|
||||
"type": "Record<`any`, `any`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "product_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductTagDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductTagDTO
|
||||
|
||||
A product tag to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the product tag.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductTypeDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductTypeDTO
|
||||
|
||||
A product type to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The product type's ID.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The product type's value.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,160 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductVariantDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductVariantDTO
|
||||
|
||||
A product variant to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "allow_backorder",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product variant can be ordered when it's out of stock.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "barcode",
|
||||
"type": "`string`",
|
||||
"description": "The barcode of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "ean",
|
||||
"type": "`string`",
|
||||
"description": "The EAN of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`number`",
|
||||
"description": "The height of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`string`",
|
||||
"description": "The HS Code of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "inventory_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The inventory quantiy of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`number`",
|
||||
"description": "The length of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manage_inventory",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product variant's inventory should be managed by the core system.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`string`",
|
||||
"description": "The material of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`string`",
|
||||
"description": "The MID Code of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`CreateProductVariantOptionDTO`](admin_discounts.internal.internal-1.ProductTypes.CreateProductVariantOptionDTO.mdx)[]",
|
||||
"description": "The product variant options to create and associate with the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`string`",
|
||||
"description": "The origin country of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "`string`",
|
||||
"description": "The SKU of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The tile of the product variant.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "upc",
|
||||
"type": "`string`",
|
||||
"description": "The UPC of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`number`",
|
||||
"description": "The weight of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`number`",
|
||||
"description": "The width of the product variant.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,158 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductVariantOnlyDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductVariantOnlyDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "allow_backorder",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "barcode",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "ean",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "inventory_quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manage_inventory",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`CreateProductVariantOptionDTO`](admin_discounts.internal.internal-1.ProductTypes.CreateProductVariantOptionDTO.mdx) & { `option`: `any` }[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "upc",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateProductVariantOptionDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).CreateProductVariantOptionDTO
|
||||
|
||||
A product variant option to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of a product variant option.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,88 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableProductCategoryProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).FilterableProductCategoryProps
|
||||
|
||||
The filters to apply on retrieved product categories.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableProductCategoryProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductCategoryProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductCategoryProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductCategoryProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableProductCategoryProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductCategoryProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductCategoryProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductCategoryProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The handles to filter product categories by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The IDs to filter product categories by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "include_descendants_tree",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether to include children of retrieved product categories.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_active",
|
||||
"type": "`boolean`",
|
||||
"description": "Filter product categories by whether they're active.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_internal",
|
||||
"type": "`boolean`",
|
||||
"description": "Filter product categories by whether they're internal.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The names to filter product categories by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "parent_category_id",
|
||||
"type": "``null`` \\| `string` \\| `string`[]",
|
||||
"description": "Filter product categories by their parent category's ID.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableProductCollectionProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).FilterableProductCollectionProps
|
||||
|
||||
The filters to apply on retrieved product collections.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableProductCollectionProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductCollectionProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableProductCollectionProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductCollectionProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductCollectionProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The IDs to filter product collections by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title to filter product collections by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableProductOptionProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).FilterableProductOptionProps
|
||||
|
||||
The filters to apply on retrieved product options.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableProductOptionProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductOptionProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductOptionProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductOptionProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableProductOptionProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductOptionProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductOptionProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductOptionProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The IDs to filter product options by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "product_id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "Filter the product options by their associated products' IDs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The titles to filter product options by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,120 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableProductProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).FilterableProductProps
|
||||
|
||||
The filters to apply on retrieved products.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableProductProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableProductProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "categories",
|
||||
"type": "`object`",
|
||||
"description": "Filters on a product's categories.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "categories.id",
|
||||
"type": "`string` \\| `string`[] \\| [`OperatorMap`](../../admin_discounts/modules/admin_discounts.internal.mdx#operatormap)<`string`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "categories.is_active",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "categories.is_internal",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "category_id",
|
||||
"type": "`string` \\| `string`[] \\| [`OperatorMap`](../../admin_discounts/modules/admin_discounts.internal.mdx#operatormap)<`string`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "collection_id",
|
||||
"type": "`string` \\| `string`[] \\| [`OperatorMap`](../../admin_discounts/modules/admin_discounts.internal.mdx#operatormap)<`string`\\>",
|
||||
"description": "Filters a product by its associated collections.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The handles to filter products by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The IDs to filter products by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "q",
|
||||
"type": "`string`",
|
||||
"description": "Search through the products' attributes, such as titles and descriptions, using this search term.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "tags",
|
||||
"type": "`object`",
|
||||
"description": "Filters on a product's tags.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "tags.value",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableProductTagProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).FilterableProductTagProps
|
||||
|
||||
The filters to apply on retrieved product tags.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableProductTagProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductTagProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductTagProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductTagProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableProductTagProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductTagProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductTagProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductTagProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The IDs to filter product tags by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value to filter product tags by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableProductTypeProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).FilterableProductTypeProps
|
||||
|
||||
The filters to apply on retrieved product types.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableProductTypeProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductTypeProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductTypeProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableProductTypeProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductTypeProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductTypeProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The IDs to filter product types by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value to filter product types by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableProductVariantProps
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).FilterableProductVariantProps
|
||||
|
||||
The filters to apply on retrieved product variants.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableProductVariantProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductVariantProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableProductVariantProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableProductVariantProps`](admin_discounts.internal.internal-1.ProductTypes.FilterableProductVariantProps.mdx)\\>)[]",
|
||||
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The IDs to filter product variants by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`object`",
|
||||
"description": "Filter product variants by their associated options.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options.id",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "product_id",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "Filter the product variants by their associated products' IDs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "The SKUs to filter product variants by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,104 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductCategoryDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductCategoryDTO
|
||||
|
||||
A product category's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "category_children",
|
||||
"type": "[`ProductCategoryDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)[]",
|
||||
"description": "The associated child categories. It may only be available if the `category_children` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product category was created.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "The description of the product category.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string`",
|
||||
"description": "The handle of the product category. The handle can be used to create slug URL paths.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product category.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_active",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product category is active.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_internal",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the product category.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "parent_category",
|
||||
"type": "[`ProductCategoryDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)",
|
||||
"description": "The associated parent category. It may only be available if the `parent_category` relation is expanded.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rank",
|
||||
"type": "`number`",
|
||||
"description": "The ranking of the product category among sibling categories.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product category was updated.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductCollectionDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductCollectionDTO
|
||||
|
||||
A product collection's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product collection was deleted.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string`",
|
||||
"description": "The handle of the product collection. The handle can be used to create slug URL paths.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product collection.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "``null`` \\| Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "products",
|
||||
"type": "[`ProductDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductDTO.mdx)[]",
|
||||
"description": "The associated products. It may only be available if the `products` relation is expanded.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title of the product collection.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,248 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductDTO
|
||||
|
||||
A product's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "categories",
|
||||
"type": "``null`` \\| [`ProductCategoryDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductCategoryDTO.mdx)[]",
|
||||
"description": "The associated product categories. It may only be available if the `categories` relation is expanded.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "collection",
|
||||
"type": "[`ProductCollectionDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductCollectionDTO.mdx)",
|
||||
"description": "The associated product collection. It may only be available if the `collection` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product was created.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product was deleted.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The description of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "discountable",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product can be discounted.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "external_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The handle of the product. The handle can be used to create slug URL paths. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The height of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The HS Code of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "images",
|
||||
"type": "[`ProductImageDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductImageDTO.mdx)[]",
|
||||
"description": "The associated product images. It may only be available if the `images` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_giftcard",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product is a gift card.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The length of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The material of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The MID Code of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`ProductOptionDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductOptionDTO.mdx)[]",
|
||||
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The origin country of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "[`ProductStatus`](../enums/admin_discounts.internal.internal-1.ProductTypes.ProductStatus.mdx)",
|
||||
"description": "The status of the product. Its value can be one of the values of the enum [ProductStatus](../enums/admin_discounts.internal.internal-1.ProductTypes.ProductStatus.mdx).",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "subtitle",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The subttle of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "tags",
|
||||
"type": "[`ProductTagDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductTagDTO.mdx)[]",
|
||||
"description": "The associated product tags. It may only be available if the `tags` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "thumbnail",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The URL of the product's thumbnail. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title of the product.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "[`ProductTypeDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductTypeDTO.mdx)[]",
|
||||
"description": "The associated product type. It may only be available if the `type` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product was updated.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "variants",
|
||||
"type": "[`ProductVariantDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductVariantDTO.mdx)[]",
|
||||
"description": "The associated product variants. It may only be available if the `variants` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The weight of the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductImageDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductImageDTO
|
||||
|
||||
The product image's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product image was deleted.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product image.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "``null`` \\| Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "url",
|
||||
"type": "`string`",
|
||||
"description": "The URL of the product image.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductOptionDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductOptionDTO
|
||||
|
||||
A product option's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product option was deleted.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product option.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "``null`` \\| Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "product",
|
||||
"type": "[`ProductDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductDTO.mdx)",
|
||||
"description": "The associated product. It may only be available if the `product` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title of the product option.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "values",
|
||||
"type": "[`ProductOptionValueDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)[]",
|
||||
"description": "The associated product option values. It may only be available if the `values` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductOptionValueDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductOptionValueDTO
|
||||
|
||||
The product option value's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product option value was deleted.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product option value.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "``null`` \\| Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "option",
|
||||
"type": "[`ProductOptionDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductOptionDTO.mdx)",
|
||||
"description": "The associated product option. It may only be available if the `option` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the product option value.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "variant",
|
||||
"type": "[`ProductVariantDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductVariantDTO.mdx)",
|
||||
"description": "The associated product variant. It may only be available if the `variant` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductTagDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductTagDTO
|
||||
|
||||
A product tag's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product tag.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "``null`` \\| Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "products",
|
||||
"type": "[`ProductDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductDTO.mdx)[]",
|
||||
"description": "The associated products. It may only be available if the `products` relation is expanded.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the product tag.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductTypeDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductTypeDTO
|
||||
|
||||
A product type's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product type was deleted.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "``null`` \\| Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the product type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,216 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductVariantDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).ProductVariantDTO
|
||||
|
||||
A product variant's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "allow_backorder",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product variant can be ordered when it's out of stock.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "barcode",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The barcode of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product variant was created.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product variant was deleted.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "ean",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The EAN of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The height of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The HS Code of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product variant.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "inventory_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The inventory quantiy of the product variant.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The length of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manage_inventory",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product variant's inventory should be managed by the core system.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The material of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "``null`` \\| Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The MID Code of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`ProductOptionValueDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductOptionValueDTO.mdx)",
|
||||
"description": "The associated product options. It may only be available if the `options` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The origin country of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "product",
|
||||
"type": "[`ProductDTO`](admin_discounts.internal.internal-1.ProductTypes.ProductDTO.mdx)",
|
||||
"description": "The associated product. It may only be available if the `product` relation is expanded.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "product_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated product.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The SKU of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The tile of the product variant.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "upc",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The UPC of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`string` \\| `Date`",
|
||||
"description": "When the product variant was updated.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "variant_rank",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The ranking of the variant among other variants associated with the product. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The weight of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "``null`` \\| `number`",
|
||||
"description": "The width of the product variant. It can possibly be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdateProductCategoryDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).UpdateProductCategoryDTO
|
||||
|
||||
The data to update in a product category.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string`",
|
||||
"description": "The handle of the product category.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_active",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product category is active.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_internal",
|
||||
"type": "`boolean`",
|
||||
"description": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the product category.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "parent_category_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "The ID of the parent product category, if it has any. It may also be `null`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rank",
|
||||
"type": "`number`",
|
||||
"description": "The ranking of the category among sibling categories.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdateProductCollectionDTO
|
||||
|
||||
[internal](../../internal/modules/admin_discounts.internal.internal-1.mdx).[ProductTypes](../../internal-1/modules/admin_discounts.internal.internal-1.ProductTypes.mdx).UpdateProductCollectionDTO
|
||||
|
||||
The data to update in a product collection. The `id` is used to identify which product collection to update.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "handle",
|
||||
"type": "`string`",
|
||||
"description": "The handle of the product collection.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the product collection to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "Holds custom data in key-value pairs.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "product_ids",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs of the products to associate with the product collection.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title of the product collection.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the product collection.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user