chore(docs): Generated References (#5593)
* chore(docs): Generated References (automated) * fix sidebar and links * removed reflection path section --------- Co-authored-by: shahednasser <shahednasser@users.noreply.github.com> Co-authored-by: Shahed nasser <shahednasser@gmail.com>
This commit is contained in:
1452 files changed
+4406556
-189818
No files matched your search
-30
@@ -1,30 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
+34
-6
@@ -6,17 +6,16 @@ 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)",
|
||||
"type": "[`AddressDTO`](../../internal/modules/internal.internal-1.mdx#addressdto)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -41,6 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -49,6 +51,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -57,15 +60,36 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "items",
|
||||
"type": "[`CreateLineItemInputDTO`](admin_discounts.internal.internal-1.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx)[]",
|
||||
"type": "[`CreateLineItemInputDTO`](internal.internal-1.WorkflowTypes.CartWorkflow.CreateLineItemInputDTO.mdx)[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "quantity",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "variant_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "region_id",
|
||||
@@ -73,6 +97,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -81,14 +106,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "shipping_address",
|
||||
"type": "[`AddressDTO`](../../internal/modules/admin_discounts.internal.internal-1.mdx#addressdto)",
|
||||
"type": "[`AddressDTO`](../../internal/modules/internal.internal-1.mdx#addressdto)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -97,6 +124,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+3
-3
@@ -4,9 +4,7 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Item
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).Item
|
||||
# CreateLineItemInputDTO
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
---
|
||||
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
|
||||
-9
@@ -1,9 +0,0 @@
|
||||
---
|
||||
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
|
||||
+21
-14
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AddressCreatePayload
|
||||
|
||||
[addresses](../../modules/addresses.mdx).[internal](../../addresses/modules/addresses.internal.mdx).AddressCreatePayload
|
||||
|
||||
#### Schema
|
||||
|
||||
Address fields used when creating an address.
|
||||
|
||||
## Properties
|
||||
@@ -18,25 +14,28 @@ Address fields used when creating an address.
|
||||
{
|
||||
"name": "address_1",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Address line 1",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_2",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Address line 2",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "city",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "City",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -45,62 +44,70 @@ Address fields used when creating an address.
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "The 2 character ISO code of the country in lower case",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "first_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "First name",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "last_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Last name",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "phone",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Phone Number",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "postal_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Postal Code",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "province",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Province",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+22
-15
@@ -6,10 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AddressPayload
|
||||
|
||||
[addresses](../../modules/addresses.mdx).[internal](../../addresses/modules/addresses.internal.mdx).AddressPayload
|
||||
|
||||
#### Schema
|
||||
|
||||
Address fields used when creating/updating an address.
|
||||
|
||||
## Properties
|
||||
@@ -18,89 +14,100 @@ Address fields used when creating/updating an address.
|
||||
{
|
||||
"name": "address_1",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Address line 1",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_2",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Address line 2",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "city",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "City",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "company",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Company",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "The 2 character ISO code of the country in lower case",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "first_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "First name",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "last_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Last name",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"description": "An optional key-value map with additional details",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "phone",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Phone Number",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "postal_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Postal Code",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "province",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "Province",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+3
-2
@@ -6,8 +6,6 @@ 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={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+7
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CustomFindOptions
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).CustomFindOptions
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -38,6 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -46,6 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -54,6 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -62,6 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -70,6 +74,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# DateComparisonOperator
|
||||
|
||||
[admin/batch-jobs](../../modules/admin_batch_jobs.mdx).[internal](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx).DateComparisonOperator
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -41,6 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+1
-5
@@ -4,8 +4,4 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# auth
|
||||
|
||||
## Classes
|
||||
|
||||
- [AuthResource](../auth/classes/auth.AuthResource.mdx)
|
||||
# EmptyQueryParams
|
||||
+18
-3
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# 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.
|
||||
|
||||
@@ -20,6 +18,7 @@ which provides correct typing of field names in its properties.
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -33,7 +32,18 @@ which provides correct typing of field names in its properties.
|
||||
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "__type",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "relations",
|
||||
@@ -41,6 +51,7 @@ which provides correct typing of field names in its properties.
|
||||
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -49,6 +60,7 @@ which provides correct typing of field names in its properties.
|
||||
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -57,6 +69,7 @@ which provides correct typing of field names in its properties.
|
||||
"description": "A number indicating the number of records to skip before retrieving the results.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -65,6 +78,7 @@ which provides correct typing of field names in its properties.
|
||||
"description": "A number indicating the number of records to return in the result.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -73,6 +87,7 @@ which provides correct typing of field names in its properties.
|
||||
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+2
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FindPaginationParams
|
||||
|
||||
[admin/currencies](../../modules/admin_currencies.mdx).[internal](../../admin_currencies/modules/admin_currencies.internal.mdx).FindPaginationParams
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+2
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FindParams
|
||||
|
||||
[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).FindParams
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# NumericalComparisonOperator
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[internal](../modules/admin_discounts.internal.internal.mdx).NumericalComparisonOperator
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -41,6 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+1
-5
@@ -4,8 +4,4 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# carts
|
||||
|
||||
## Classes
|
||||
|
||||
- [CartsResource](../carts/classes/carts.CartsResource.mdx)
|
||||
# RepositoryTransformOptions
|
||||
+4
-2
@@ -6,8 +6,6 @@ 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={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -41,6 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+7
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# StringComparisonOperator
|
||||
|
||||
[admin/customer-groups](../../modules/admin_customer_groups.mdx).[internal](../../admin_customer_groups/modules/admin_customer_groups.internal.mdx).StringComparisonOperator
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -41,6 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -49,6 +51,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -57,6 +60,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -65,6 +69,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+46
-4
@@ -6,8 +6,6 @@ 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={[
|
||||
@@ -17,7 +15,27 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "relations",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "select",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "listConfig.relations",
|
||||
@@ -25,6 +43,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +52,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -41,7 +61,27 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "relations",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "select",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "retrieveConfig.relations",
|
||||
@@ -49,6 +89,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -57,6 +98,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
-601
@@ -1,601 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
-437
@@ -1,437 +0,0 @@
|
||||
---
|
||||
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)
|
||||
+5
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -28,18 +27,20 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`BaseFilterable`](admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<`T`\\> \\| `T`)[]",
|
||||
"type": "([`BaseFilterable`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`BaseFilterable`](admin_discounts.internal.internal-1.DAL.BaseFilterable.mdx)<`T`\\> \\| `T`)[]",
|
||||
"type": "([`BaseFilterable`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+11
-4
@@ -6,8 +6,6 @@ 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={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -38,14 +38,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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)\\>",
|
||||
"type": "`boolean` \\| `string`[] \\| [`Dictionary`](../../modules/internal.mdx#dictionary)<`boolean` \\| [`Dictionary`](../../modules/internal.mdx#dictionary)\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -54,6 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -62,6 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -70,14 +74,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "orderBy",
|
||||
"type": "[`Order`](../../admin_discounts/modules/admin_discounts.internal.mdx#order)<`T`\\> \\| [`Order`](../../admin_discounts/modules/admin_discounts.internal.mdx#order)<`T`\\>[]",
|
||||
"type": "[`Order`](../../modules/internal.mdx#order)<`T`\\> \\| [`Order`](../../modules/internal.mdx#order)<`T`\\>[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -86,6 +92,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+934
@@ -0,0 +1,934 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# 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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Methods
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ids",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### find
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../../internal-1/modules/internal.internal-1.DAL.mdx#findoptions)<`T`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### findAndCount
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../../internal-1/modules/internal.internal-1.DAL.mdx#findoptions)<`T`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], `number`]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "number",
|
||||
"type": "`number`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### getActiveManager
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
___
|
||||
|
||||
### getFreshManager
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
___
|
||||
|
||||
### restore
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ids",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], Record<`string`, `unknown`[]\\>]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "Record",
|
||||
"type": "Record<`string`, `unknown`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "string",
|
||||
"type": "`string`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "unknown[]",
|
||||
"type": "`unknown`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### serialize
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TOutput`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### softDelete
|
||||
|
||||
Soft delete entities and cascade to related entities if configured.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "ids",
|
||||
"type": "`string`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<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",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "Record",
|
||||
"type": "Record<`string`, `unknown`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "string",
|
||||
"type": "`string`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "unknown[]",
|
||||
"type": "`unknown`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### transaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "task",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "__type",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transaction",
|
||||
"type": "`TManager`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "context.enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.transaction",
|
||||
"type": "`TManager`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`any`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "any",
|
||||
"type": "`any`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`unknown`[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+2
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ An object that is used to specify an entity's related entities that should be re
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -32,6 +31,7 @@ An object that is used to specify an entity's related entities that should be re
|
||||
"description": "An array of strings, each being the ID attribute names of the entity's relations.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+2
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ An object that is used to specify an entity's related entities that should be so
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -32,6 +31,7 @@ An object that is used to specify an entity's related entities that should be so
|
||||
"description": "An array of strings, each being the ID attribute names of the entity's relations.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+593
@@ -0,0 +1,593 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# 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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
## Methods
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`unknown`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`void`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### find
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../../internal-1/modules/internal.internal-1.DAL.mdx#findoptions)<`T`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transformOptions",
|
||||
"type": "[`RepositoryTransformOptions`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`T`[]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### findAndCount
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "options",
|
||||
"type": "[`FindOptions`](../../internal-1/modules/internal.internal-1.DAL.mdx#findoptions)<`T`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transformOptions",
|
||||
"type": "[`RepositoryTransformOptions`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.RepositoryTransformOptions.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "[`Context`](../../internal-1/interfaces/internal.internal-1.Context.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "a boolean value indicating whether nested transactions are enabled.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "manager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionId",
|
||||
"type": "`string`",
|
||||
"description": "a string indicating the ID of the current transaction.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transactionManager",
|
||||
"type": "`TManager`",
|
||||
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<[`T`[], `number`]\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "T[]",
|
||||
"type": "`T`[]",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "number",
|
||||
"type": "`number`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### getActiveManager
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
___
|
||||
|
||||
### getFreshManager
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
___
|
||||
|
||||
### serialize
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "data",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "options",
|
||||
"type": "`any`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`TOutput`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### transaction
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "task",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "__type",
|
||||
"type": "(`transactionManager`: `TManager`) => `Promise`<`any`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "transaction",
|
||||
"type": "`TManager`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "context.enableNestedTransactions",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.isolationLevel",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context.transaction",
|
||||
"type": "`TManager`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "Promise",
|
||||
"type": "`Promise`<`any`\\>",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "any",
|
||||
"type": "`any`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+1925
File diff suppressed because it is too large.
Load diff
+1
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Abortable
|
||||
|
||||
[internal](../../admin_discounts/modules/admin_discounts.internal.mdx).[EventEmitter](../../internal/modules/admin_discounts.internal.EventEmitter.mdx).Abortable
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+48
@@ -0,0 +1,48 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# EventEmitterAsyncResourceOptions
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "captureRejections",
|
||||
"type": "`boolean`",
|
||||
"description": "Enables automatic capturing of promise rejection.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The type of async event, this is required when instantiating `EventEmitterAsyncResource` directly rather than as a child class.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "requireManualDestroy",
|
||||
"type": "`boolean`",
|
||||
"description": "Disables automatic `emitDestroy` when the object is garbage collected. This usually does not need to be set (even if `emitDestroy` is called manually), unless the resource's `asyncId` is retrieved and the sensitive API's `emitDestroy` is called with it.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "triggerAsyncId",
|
||||
"type": "`number`",
|
||||
"description": "The ID of the execution context that created this async event.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+341
@@ -0,0 +1,341 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# EventEmitterReferencingAsyncResource
|
||||
|
||||
The class `AsyncResource` is designed to be extended by the embedder's async
|
||||
resources. Using this, users can easily trigger the lifetime events of their
|
||||
own resources.
|
||||
|
||||
The `init` hook will trigger when an `AsyncResource` is instantiated.
|
||||
|
||||
The following is an overview of the `AsyncResource` API.
|
||||
|
||||
```js
|
||||
import { AsyncResource, executionAsyncId } from 'node:async_hooks';
|
||||
|
||||
// AsyncResource() is meant to be extended. Instantiating a
|
||||
// new AsyncResource() also triggers init. If triggerAsyncId is omitted then
|
||||
// async_hook.executionAsyncId() is used.
|
||||
const asyncResource = new AsyncResource(
|
||||
type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false },
|
||||
);
|
||||
|
||||
// Run a function in the execution context of the resource. This will
|
||||
// * establish the context of the resource
|
||||
// * trigger the AsyncHooks before callbacks
|
||||
// * call the provided function `fn` with the supplied arguments
|
||||
// * trigger the AsyncHooks after callbacks
|
||||
// * restore the original execution context
|
||||
asyncResource.runInAsyncScope(fn, thisArg, ...args);
|
||||
|
||||
// Call AsyncHooks destroy callbacks.
|
||||
asyncResource.emitDestroy();
|
||||
|
||||
// Return the unique ID assigned to the AsyncResource instance.
|
||||
asyncResource.asyncId();
|
||||
|
||||
// Return the trigger ID for the AsyncResource instance.
|
||||
asyncResource.triggerAsyncId();
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "eventEmitter",
|
||||
"type": "[`EventEmitterAsyncResource`](../classes/internal.EventEmitter.EventEmitterAsyncResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "asyncId",
|
||||
"type": "`number`",
|
||||
"description": "The unique asyncId assigned to the resource.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "asyncResource",
|
||||
"type": "[`EventEmitterReferencingAsyncResource`](internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx)",
|
||||
"description": "The underlying AsyncResource",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "eventEmitter",
|
||||
"type": "[`EventEmitterAsyncResource`](../classes/internal.EventEmitter.EventEmitterAsyncResource.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "asyncId",
|
||||
"type": "`number`",
|
||||
"description": "The unique asyncId assigned to the resource.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "asyncResource",
|
||||
"type": "[`EventEmitterReferencingAsyncResource`](internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx)",
|
||||
"description": "The underlying AsyncResource",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "triggerAsyncId",
|
||||
"type": "`number`",
|
||||
"description": "The same triggerAsyncId that is passed to the AsyncResource constructor.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "captureRejectionSymbol",
|
||||
"type": "typeof [`captureRejectionSymbol`](../../internal/classes/internal.Socket.mdx#capturerejectionsymbol)",
|
||||
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "captureRejections",
|
||||
"type": "`boolean`",
|
||||
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "defaultMaxListeners",
|
||||
"type": "`number`",
|
||||
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "errorMonitor",
|
||||
"type": "typeof [`errorMonitor`](../../internal/classes/internal.Socket.mdx#errormonitor)",
|
||||
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "triggerAsyncId",
|
||||
"type": "`number`",
|
||||
"description": "The same triggerAsyncId that is passed to the AsyncResource constructor.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "captureRejectionSymbol",
|
||||
"type": "typeof [`captureRejectionSymbol`](../../internal/classes/internal.Socket.mdx#capturerejectionsymbol)",
|
||||
"description": "Value: `Symbol.for('nodejs.rejection')` See how to write a custom `rejection handler`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "captureRejections",
|
||||
"type": "`boolean`",
|
||||
"description": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) Change the default `captureRejections` option on all new `EventEmitter` objects.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "defaultMaxListeners",
|
||||
"type": "`number`",
|
||||
"description": "By default, a maximum of `10` listeners can be registered for any single event. This limit can be changed for individual `EventEmitter` instances using the `emitter.setMaxListeners(n)` method. To change the default for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. Take caution when setting the `events.defaultMaxListeners` because the change affects _all_`EventEmitter` instances, including those created before the change is made. However, calling `emitter.setMaxListeners(n)` still has precedence over `events.defaultMaxListeners`. This is not a hard limit. The `EventEmitter` instance will allow more listeners to be added but will output a trace warning to stderr indicating that a \"possible EventEmitter memory leak\" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to temporarily avoid this warning: ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.setMaxListeners(emitter.getMaxListeners() + 1); emitter.once('event', () => { // do stuff emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); }); ``` The `--trace-warnings` command-line flag can be used to display the stack trace for such warnings. The emitted warning can be inspected with `process.on('warning')` and will have the additional `emitter`, `type`, and `count` properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its `name` property is set to `'MaxListenersExceededWarning'`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "errorMonitor",
|
||||
"type": "typeof [`errorMonitor`](../../internal/classes/internal.Socket.mdx#errormonitor)",
|
||||
"description": "This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no regular `'error'` listener is installed.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
|
||||
## Methods
|
||||
|
||||
### asyncId
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "number",
|
||||
"type": "`number`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "The unique `asyncId` assigned to the resource.",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### bind
|
||||
|
||||
Binds the given function to execute to this `AsyncResource`'s scope.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "fn",
|
||||
"type": "`Func`",
|
||||
"description": "The function to bind to the current `AsyncResource`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
#### Since
|
||||
|
||||
v14.8.0, v12.19.0
|
||||
|
||||
___
|
||||
|
||||
### emitDestroy
|
||||
|
||||
Call all `destroy` hooks. This should only ever be called once. An error will
|
||||
be thrown if it is called more than once. This **must** be manually called. If
|
||||
the resource is left to be collected by the GC then the `destroy` hooks will
|
||||
never be called.
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "EventEmitterReferencingAsyncResource",
|
||||
"type": "[`EventEmitterReferencingAsyncResource`](internal.EventEmitter.EventEmitterReferencingAsyncResource.mdx)",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"description": "A reference to `asyncResource`.",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
### runInAsyncScope
|
||||
|
||||
Call the provided function with the provided arguments in the execution context
|
||||
of the async resource. This will establish the context, trigger the AsyncHooks
|
||||
before callbacks, call the function, trigger the AsyncHooks after callbacks, and
|
||||
then restore the original execution context.
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "fn",
|
||||
"type": "(`this`: `This`, ...`args`: `any`[]) => `Result`",
|
||||
"description": "The function to call in the execution context of this async resource.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "__type",
|
||||
"type": "(`this`: `This`, ...`args`: `any`[]) => `Result`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "thisArg",
|
||||
"type": "`This`",
|
||||
"description": "The receiver to be used for the function call.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "args",
|
||||
"type": "`any`[]",
|
||||
"description": "Optional arguments to pass to the function.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[]} />
|
||||
|
||||
#### Since
|
||||
|
||||
v9.6.0
|
||||
|
||||
___
|
||||
|
||||
### triggerAsyncId
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "number",
|
||||
"type": "`number`",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"description": "The same `triggerAsyncId` that is passed to the `AsyncResource` constructor.",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
-34
@@ -1,34 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# 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`](../../internal/classes/admin_discounts.internal.FlagRouter.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "isFeatureEnabled",
|
||||
"type": "(`key`: `string`) => `boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "listFlags",
|
||||
"type": "() => [`FeatureFlagsResponse`](../../internal-1/modules/admin_discounts.internal.internal-1.FeatureFlagTypes.mdx#featureflagsresponse)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+54
@@ -0,0 +1,54 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# IFlagRouter
|
||||
|
||||
## Implemented by
|
||||
|
||||
- [`FlagRouter`](../../internal/classes/internal.FlagRouter.mdx)
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "isFeatureEnabled",
|
||||
"type": "(`key`: `string`) => `boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "__type",
|
||||
"type": "(`key`: `string`) => `boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "listFlags",
|
||||
"type": "() => [`FeatureFlagsResponse`](../../internal-1/modules/internal.internal-1.FeatureFlagTypes.mdx#featureflagsresponse)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "__type",
|
||||
"type": "() => [`FeatureFlagsResponse`](../../internal-1/modules/internal.internal-1.FeatureFlagTypes.mdx#featureflagsresponse)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
+13
-2
@@ -6,8 +6,6 @@ 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={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -41,6 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -49,6 +51,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -57,6 +60,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -65,6 +69,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -73,6 +78,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -81,6 +87,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -89,6 +96,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -97,6 +105,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -105,6 +114,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -113,6 +123,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+139
@@ -0,0 +1,139 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreateInventoryItemsWorkflowInputDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "inventoryItems",
|
||||
"type": "[`CreateInventoryItemInputDTO`](internal.internal-1.WorkflowTypes.InventoryWorkflow.CreateInventoryItemInputDTO.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "description",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "height",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "hs_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "length",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "material",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "mid_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "origin_country",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "sku",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "thumbnail",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "weight",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "width",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# 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
|
||||
|
||||
### ISOLATED
|
||||
-2
@@ -6,8 +6,6 @@ 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
|
||||
-110
@@ -1,110 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
+220
@@ -0,0 +1,220 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ModuleServiceInitializeOptions
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "database",
|
||||
"type": "`object`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "clientUrl",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "connection",
|
||||
"type": "`any`",
|
||||
"description": "Forces to use a shared knex connection",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "debug",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "driverOptions",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "host",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "password",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "pool",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "port",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "schema",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "user",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "database.clientUrl",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.connection",
|
||||
"type": "`any`",
|
||||
"description": "Forces to use a shared knex connection",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.database",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.debug",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.driverOptions",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.host",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.password",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.pool",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.port",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.schema",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "database.user",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
-32
@@ -1,32 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-32
@@ -1,32 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-30
@@ -1,30 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-40
@@ -1,40 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-48
@@ -1,48 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-48
@@ -1,48 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-88
@@ -1,88 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-40
@@ -1,40 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-64
@@ -1,64 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-48
@@ -1,48 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-46
@@ -1,46 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-46
@@ -1,46 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
+133
@@ -0,0 +1,133 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# 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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "prices",
|
||||
"type": "[`CreatePricesDTO`](internal.internal-1.PricingTypes.CreatePricesDTO.mdx)[]",
|
||||
"description": "The prices to add to the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CreateCurrencyDTO`](internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)",
|
||||
"description": "The currency of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+13
-3
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The rules to add to a price set.
|
||||
"description": "The ID of the price set to add the rules to.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,17 @@ The rules to add to a price set.
|
||||
"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": []
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "attribute",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+5
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ A calculated price set's data.
|
||||
"description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ A calculated price set's data.
|
||||
"description": "The currency code of the calculated price. It can possibly be `null`.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ A calculated price set's data.
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ A calculated price set's data.
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +53,7 @@ A calculated price set's data.
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ A currency to create.
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ A currency to create.
|
||||
"description": "The name of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ A currency to create.
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ A currency to create.
|
||||
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+45
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,15 +17,54 @@ The money amount to create.
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CreateCurrencyDTO`](admin_discounts.internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)",
|
||||
"type": "[`CreateCurrencyDTO`](internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)",
|
||||
"description": "The currency of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
@@ -35,6 +72,7 @@ The money amount to create.
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +81,7 @@ The money amount to create.
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +90,7 @@ The money amount to create.
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,6 +99,7 @@ The money amount to create.
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+7
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ A price rule to create.
|
||||
"description": "The ID of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ A price rule to create.
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ A price rule to create.
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ A price rule to create.
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +53,7 @@ A price rule to create.
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,6 +62,7 @@ A price rule to create.
|
||||
"description": "The ID of the associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -67,6 +71,7 @@ A price rule to create.
|
||||
"description": "The value of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+143
@@ -0,0 +1,143 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreatePriceSetDTO
|
||||
|
||||
A price set to create.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "prices",
|
||||
"type": "[`CreatePricesDTO`](internal.internal-1.PricingTypes.CreatePricesDTO.mdx)[]",
|
||||
"description": "The prices to create and add to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CreateCurrencyDTO`](internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)",
|
||||
"description": "The currency of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "rule_attribute",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+5
-4
@@ -6,25 +6,25 @@ 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)",
|
||||
"type": "`string` \\| [`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "`string` \\| [`PriceSetDTO`](admin_discounts.internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"type": "`string` \\| [`PriceSetDTO`](internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+3
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The price set money amount rule to create.
|
||||
"description": "The ID of a price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ The price set money amount rule to create.
|
||||
"description": "The ID of a rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ The price set money amount rule to create.
|
||||
"description": "The value of the price set money amount rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+224
@@ -0,0 +1,224 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# CreatePriceSetRuleTypeDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+46
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,15 +17,54 @@ The prices to create part of a price set.
|
||||
"description": "The amount of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CreateCurrencyDTO`](admin_discounts.internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)",
|
||||
"type": "[`CreateCurrencyDTO`](internal.internal-1.PricingTypes.CreateCurrencyDTO.mdx)",
|
||||
"description": "The currency of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
@@ -35,6 +72,7 @@ The prices to create part of a price set.
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +81,7 @@ The prices to create part of a price set.
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +90,7 @@ The prices to create part of a price set.
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,6 +99,7 @@ The prices to create part of a price set.
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -67,6 +108,7 @@ The prices to create part of a price set.
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The rule type to create.
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ The rule type to create.
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ The rule type to create.
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ The rule type to create.
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ A currency's data.
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ A currency's data.
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ A currency's data.
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ A currency's data.
|
||||
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterableCurrencyProps
|
||||
|
||||
Filters to apply on a currency.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableCurrencyProps`](internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableCurrencyProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableCurrencyProps`](internal.internal-1.PricingTypes.FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableCurrencyProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`[]",
|
||||
"description": "The codes to filter the currencies by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+6
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -15,18 +13,20 @@ Filters to apply on a money amount.
|
||||
<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)\\>)[]",
|
||||
"type": "([`FilterableMoneyAmountProps`](internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](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": "",
|
||||
"expandable": false,
|
||||
"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)\\>)[]",
|
||||
"type": "([`FilterableMoneyAmountProps`](internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ Filters to apply on a money amount.
|
||||
"description": "Currency codes to filter money amounts by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ Filters to apply on a money amount.
|
||||
"description": "IDs to filter money amounts by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+8
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -15,18 +13,20 @@ Filters to apply to price rules.
|
||||
<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)\\>)[]",
|
||||
"type": "([`FilterablePriceRuleProps`](internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceRuleProps`](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": "",
|
||||
"expandable": false,
|
||||
"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)\\>)[]",
|
||||
"type": "([`FilterablePriceRuleProps`](internal.internal-1.PricingTypes.FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceRuleProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ Filters to apply to price rules.
|
||||
"description": "The IDs to filter price rules by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ Filters to apply to price rules.
|
||||
"description": "The names to filter price rules by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +53,7 @@ Filters to apply to price rules.
|
||||
"description": "The IDs to filter the price rule's associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,6 +62,7 @@ Filters to apply to price rules.
|
||||
"description": "The IDs to filter the price rule's associated rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+50
@@ -0,0 +1,50 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterablePriceSetMoneyAmountProps
|
||||
|
||||
Filters to apply on price set money amounts.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterablePriceSetMoneyAmountProps`](internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterablePriceSetMoneyAmountProps`](internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs to filter the price set money amounts by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`[]",
|
||||
"description": "The IDs to filter the price set money amount's associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+8
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -15,18 +13,20 @@ Filters to apply on price set money amount rules.
|
||||
<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)\\>)[]",
|
||||
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](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": "",
|
||||
"expandable": false,
|
||||
"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)\\>)[]",
|
||||
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](internal.internal-1.PricingTypes.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ Filters to apply on price set money amount rules.
|
||||
"description": "The ID to filter price set money amount rules by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ Filters to apply on price set money amount rules.
|
||||
"description": "The IDs to filter the price set money amount rule's associated price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +53,7 @@ Filters to apply on price set money amount rules.
|
||||
"description": "The IDs to filter the price set money amount rule's associated rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,6 +62,7 @@ Filters to apply on price set money amount rules.
|
||||
"description": "The value to filter price set money amount rules by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+87
@@ -0,0 +1,87 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FilterablePriceSetProps
|
||||
|
||||
Filters to apply on price sets.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterablePriceSetProps`](internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterablePriceSetProps`](internal.internal-1.PricingTypes.FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "IDs to filter price sets by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`FilterableMoneyAmountProps`](internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx)",
|
||||
"description": "Filters to apply on a price set's associated money amounts.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "$and",
|
||||
"type": "([`FilterableMoneyAmountProps`](internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "$or",
|
||||
"type": "([`FilterableMoneyAmountProps`](internal.internal-1.PricingTypes.FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string` \\| `string`[]",
|
||||
"description": "Currency codes to filter money amounts by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`[]",
|
||||
"description": "IDs to filter money amounts by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+7
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -15,18 +13,20 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
<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)\\>)[]",
|
||||
"type": "([`FilterablePriceSetRuleTypeProps`](internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetRuleTypeProps`](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": "",
|
||||
"expandable": false,
|
||||
"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)\\>)[]",
|
||||
"type": "([`FilterablePriceSetRuleTypeProps`](internal.internal-1.PricingTypes.FilterablePriceSetRuleTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterablePriceSetRuleTypeProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +53,7 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+7
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -15,18 +13,20 @@ Filters to apply on rule types.
|
||||
<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)\\>)[]",
|
||||
"type": "([`FilterableRuleTypeProps`](internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableRuleTypeProps`](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": "",
|
||||
"expandable": false,
|
||||
"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)\\>)[]",
|
||||
"type": "([`FilterableRuleTypeProps`](internal.internal-1.PricingTypes.FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../DAL/interfaces/internal.internal-1.DAL.BaseFilterable.mdx)<[`FilterableRuleTypeProps`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ Filters to apply on rule types.
|
||||
"description": "The IDs to filter rule types by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ Filters to apply on rule types.
|
||||
"description": "The names to filter rule types by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +53,7 @@ Filters to apply on rule types.
|
||||
"description": "The rule attributes to filter rule types by.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+45
-4
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,15 +17,54 @@ A money amount's data. A money amount represents a price.
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](admin_discounts.internal.internal-1.PricingTypes.CurrencyDTO.mdx)",
|
||||
"type": "[`CurrencyDTO`](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": []
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
@@ -35,6 +72,7 @@ A money amount's data. A money amount represents a price.
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +81,7 @@ A money amount's data. A money amount represents a price.
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +90,7 @@ A money amount's data. A money amount represents a price.
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,6 +99,7 @@ A money amount's data. A money amount represents a price.
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+289
@@ -0,0 +1,289 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceRuleDTO
|
||||
|
||||
A price rule's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+170
@@ -0,0 +1,170 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceSetDTO
|
||||
|
||||
A price set's data.
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]} />
|
||||
+556
@@ -0,0 +1,556 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# 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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amount",
|
||||
"type": "[`MoneyAmountDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_rules",
|
||||
"type": "[`PriceRuleDTO`](internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title of the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+501
@@ -0,0 +1,501 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# 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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount",
|
||||
"type": "[`PriceSetMoneyAmountDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of a price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amount",
|
||||
"type": "[`MoneyAmountDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_rules",
|
||||
"type": "[`PriceRuleDTO`](internal.internal-1.PricingTypes.PriceRuleDTO.mdx)[]",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amount_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_type_id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "The title of the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the price set money amount rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+242
@@ -0,0 +1,242 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PriceSetRuleTypeDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+1
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The context to calculate prices. For example, you can specify the currency code
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+1
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ Filters to apply on prices.
|
||||
"description": "IDs to filter prices.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+2
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The rules to remove from a price set.
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ The rules to remove from a price set.
|
||||
"description": "The rules to remove. Each string is the `rule_attribute` of a rule to remove.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ A rule type's data.
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ A rule type's data.
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ A rule type's data.
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ A rule type's data.
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The data to update in a currency. The `code` is used to identify which currency
|
||||
"description": "The code of the currency to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ The data to update in a currency. The `code` is used to identify which currency
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ The data to update in a currency. The `code` is used to identify which currency
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ The data to update in a currency. The `code` is used to identify which currency
|
||||
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+5
-2
@@ -6,8 +6,6 @@ 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.
|
||||
@@ -21,6 +19,7 @@ The data to update in a money amount. The `id` is used to identify which money a
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -29,6 +28,7 @@ The data to update in a money amount. The `id` is used to identify which money a
|
||||
"description": "The code of the currency to associate with the money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -37,6 +37,7 @@ The data to update in a money amount. The `id` is used to identify which money a
|
||||
"description": "The ID of the money amount to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -45,6 +46,7 @@ The data to update in a money amount. The `id` is used to identify which money a
|
||||
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -53,6 +55,7 @@ The data to update in a money amount. The `id` is used to identify which money a
|
||||
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+7
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
|
||||
"description": "The ID of the price rule to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
|
||||
"description": "The ID of the associated price list.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
|
||||
"description": "The ID of the associated price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -51,6 +53,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
|
||||
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -59,6 +62,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
|
||||
"description": "The ID of the associated rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -67,6 +71,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
|
||||
"description": "The value of the price rule.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+1
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The data to update in a price set. The `id` is used to identify which price set
|
||||
"description": "A string indicating the ID of the price set to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+297
@@ -0,0 +1,297 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# UpdatePriceSetMoneyAmountDTO
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amount",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[`PriceSetDTO`](internal.internal-1.PricingTypes.PriceSetDTO.mdx)",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "money_amounts",
|
||||
"type": "[`MoneyAmountDTO`](internal.internal-1.PricingTypes.MoneyAmountDTO.mdx)[]",
|
||||
"description": "The prices that belong to this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
"type": "`number`",
|
||||
"description": "The price of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`CurrencyDTO`](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": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "The code of the currency.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The name of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "The symbol of the currency.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "The currency code of this money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the money amount.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "max_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The maximum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "min_quantity",
|
||||
"type": "`number`",
|
||||
"description": "The minimum quantity required to be purchased for this price to be applied.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[`RuleTypeDTO`](internal.internal-1.PricingTypes.RuleTypeDTO.mdx)[]",
|
||||
"description": "The rule types applied on this price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": [
|
||||
{
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "title",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The data to update in a price set money amount rule. The `id` is used to identif
|
||||
"description": "The ID of the price set money amount rule to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ The data to update in a price set money amount rule. The `id` is used to identif
|
||||
"description": "The ID of a price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ The data to update in a price set money amount rule. The `id` is used to identif
|
||||
"description": "The ID of a rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ The data to update in a price set money amount rule. The `id` is used to identif
|
||||
"description": "The value of the price set money amount rule.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+3
-2
@@ -6,8 +6,6 @@ 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={[
|
||||
@@ -17,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -25,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -33,6 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
+4
-2
@@ -6,8 +6,6 @@ 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
|
||||
@@ -19,6 +17,7 @@ The data to update in a rule type. The `id` is used to identify which price set
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -27,6 +26,7 @@ The data to update in a rule type. The `id` is used to identify which price set
|
||||
"description": "The ID of the rule type to update.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -35,6 +35,7 @@ The data to update in a rule type. The `id` is used to identify which price set
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
@@ -43,6 +44,7 @@ The data to update in a rule type. The `id` is used to identify which price set
|
||||
"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": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
-2
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ProductStatus
|
||||
|
||||
[admin/collections](../../modules/admin_collections.mdx).[internal](../../admin_collections/modules/admin_collections.internal.mdx).ProductStatus
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### DRAFT
|
||||
-216
@@ -1,216 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-6626
File diff suppressed because it is too large.
Load diff
-104
@@ -1,104 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-64
@@ -1,64 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-248
@@ -1,248 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-64
@@ -1,64 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-64
@@ -1,64 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
-48
@@ -1,48 +0,0 @@
|
||||
---
|
||||
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": []
|
||||
}
|
||||
]} />
|
||||
Loaded 100 of 1452 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user